LuisMayo / LuisMayo/objection_engine

"Issue" with README installation instructions

Open
#101 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
122
Forks
24
PR merge metrics
No merged PRs in 30d

Description

The README currently says
> Install dependencies (in case any problems are encountered please check faq.md) You can use either pip
> ```
> python -m pip install .
> ```

While this is technically true - it *does* install the dependencies and allow the sample scripts to be executed - it also installs *Objection!* on the system as a Python package. Making changes to the files inside of the `objection_engine` directory isn't reflected when you run the example scripts to test them, because Python is using the copy of `objection_engine` it installed before the changes were made.

The instructions are in the "Installation" section, so perhaps that's on me for not thinking critically about what I was doing, haha. But I still think it might be good to make this clearer. I'd been developing this way using Poetry before, so maybe the README should explain that Poetry is the way to go when actively modifying and testing the engine?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Update the README's Installation section, which currently documents `python -m pip install .`; compare that guidance with the issue's mention of Poetry and active engine development. Make it clear how to modify `objection_engine` and have those changes reflected when running the example scripts, then verify the instructions match the repository workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.