Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation cleanup #4

Open
ma595 opened this issue Sep 11, 2024 · 0 comments
Open

Documentation cleanup #4

ma595 opened this issue Sep 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation health

Comments

@ma595
Copy link
Member

ma595 commented Sep 11, 2024 •
edited
Loading

The README.md needs the following updates:

  • Parts seem slightly out of date. main.py does not exist, for instance.
  • French language parts - consider translating to English to make more accessible.
  • Spelling mistakes.
  • Installation instructions (will come later as we package the tool properly).
  • Instructions on getting the data and running the tool using the Jumper.ipynb notebook.
@ma595 ma595 moved this to Todo in ICCS Development Board Sep 18, 2024
@ma595 ma595 added documentation Improvements or additions to documentation health labels Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation health
Projects
ICCS Development Board
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ma595