search

pollen-robotics / python-template

Python coding guidelines. Can be used as a template project
Apache License 2.0
0 stars 2 forks source link

Document installation #5

Closed FabienDanieau closed 9 months ago

FabienDanieau commented 1 year ago

Document the installation procedure: i.e. pip install ..

See @RemiFabre comment from https://github.com/pollen-robotics/python-coding-guidelines/pull/4

I believe there should be a small section on what should be in the README.md of a repo (maybe add a template somewhere?), with at least the procedure to install, run and test the code. This should also be present in this repo's README. For example I had to :
pip3 install -r requirements.txt
pip3 install lark
FabienDanieau commented 9 months ago

documented in readme