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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

馃摑 Add documentation and Readme #5

Closed
chatonmars opened this issue Mar 6, 2023 · 0 comments 路 Fixed by #12
Closed

馃摑 Add documentation and Readme #5

chatonmars opened this issue Mar 6, 2023 · 0 comments 路 Fixed by #12
Assignees
@chatonmars
Labels
documentation Improvements or additions to documentation
Milestone
1.0

Comments

@chatonmars
Copy link
Owner

Write some docstring in the script as well as the Readme:

  • Description
  • How to use / Install
  • Options
  • Dependencies
  • Bug report / suggestions
@chatonmars chatonmars self-assigned this Mar 6, 2023
@chatonmars chatonmars added the documentation Improvements or additions to documentation label Mar 6, 2023
@chatonmars chatonmars added this to the 1.0 milestone Mar 6, 2023
@chatonmars chatonmars mentioned this issue Mar 9, 2023
Merged
@chatonmars chatonmars linked a pull request Mar 9, 2023 that will close this issue
馃摑 Add documentation and Readme #12
Merged
chatonmars added a commit that referenced this issue Mar 10, 2023
@chatonmars
馃摑 Add documentation and Readme (#12)
acd2fb3 
resolve #5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chatonmars chatonmars

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
1.0
Development

Successfully merging a pull request may close this issue.

馃摑 Add documentation and Readme chatonmars/RAYD
1 participant
@chatonmars