search

skent259 / crapssim

Simulator for craps with various betting strategies
MIT License
28 stars 13 forks source link

Improve crapssim development install instructions #21

Closed sigsegved closed 2 years ago

sigsegved commented 2 years ago

Added instructions and things required to make the package work without Conda environments.

skent259 commented 2 years ago

The package works without conda, so I changed the name. I agree that there should be better instructions for contributing, but I don't think it should be in the main README.md.

It would be better to have install instructions in a docs folder, maybe using this as a guide: https://github.com/has2k1/plotnine/blob/main/doc/installation.rst

In particular, the development instructions more closely follow https://realpython.com/what-is-pip/#installing-packages-in-editable-mode-to-ease-development, which I need to test, but seem better than using a requirements.txt file. Ultimately, I need to fix setup.cfg with the right requirements

skent259 commented 2 years ago

@sigsegved Can you take a look at #22? I think this should clarify the easiest way to contribute to the repository, but would like your input

sigsegved commented 2 years ago

closing in favor of https://github.com/skent259/crapssim/pull/22