search

herobank110 / factorygame

Python game engine to have a 2d movable "graph".
https://factorygame.readthedocs.io
MIT License
1 stars 2 forks source link

run_test.py not in pip distribution #6

Open jldohmann opened 3 years ago

jldohmann commented 3 years ago

Hi, saw your post on DEV and thought this was a cool project! Would love to help out for Hacktoberfest 😄

I installed via pip, but run_test.py I think only comes with cloning the repo. It wasn't clear from the docs, so maybe a good task would be to add more explicit instructions for getting started. I'm happy to do that! Could also add the file to the pip package as well.

herobank110 commented 3 years ago

Hi, thanks so much for your interest. The current getting started documentation is certainly unclear about how to run the tests.

I was tentative to include any of the tests in the published package since they weren't namespaced under the factorygame package, but I agree that having access to them would be beneficial for getting started.

Do you think it would be clearer if the documentation had a new section "Explore Demos" under getting started that showed the steps to download the repo and run the tests?

jldohmann commented 3 years ago

Do you think it would be clearer if the documentation had a new section "Explore Demos" under getting started that showed the steps to download the repo and run the tests?

Yes, absolutely. I'll draft something up and submit a PR if that's alright

herobank110 commented 3 years ago

Thanks 😊