LuisMayo / objection_engine

Library that turns comment chains into ace attorney scenes, used in several bots
MIT License
105 stars 20 forks source link

"Issue" with README installation instructions #101

Open Meorge opened 1 year ago

Meorge commented 1 year ago

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?