README.md - Githubissues

sudlab / IsoSLAM

MIT License

0 stars 0 forks source link

README.md #4

Closed ns-rse closed 1 week ago

ns-rse commented 1 week ago

Write a README.md giving an overview of what the software does.

Sections and things to include...

[ ] Mermaid diagram showing pipeline based on slam3UI_pipeline_instructions - Google Docs
[ ] Installation instructions (will evolve over time from GitHub install to PyPI)
[ ] Link to Contributing guidelines
[ ] Include badges for...
- Ruff
- Black
- Pylint
- License (once decided, see #3)
- Python versions
- PyPI (once released, won't be a while though)