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

Add a readme with documentation on the scripts in the bin folder #781

Open
andreicuceu opened this issue Mar 31, 2021 · 1 comment
Open

Add a readme with documentation on the scripts in the bin folder #781

andreicuceu opened this issue Mar 31, 2021 · 1 comment
Labels
enhancement first_issue

Comments

@andreicuceu
Copy link
Contributor

As a lot of the work in picca gets done by scripts in the bin folder, it would be nice to have a readme explaining what each of them does, and maybe guiding people on what is best practice for certain use cases. Also some description of the input parameters (I know there is --help, but a centralized documentation is definitely better) and examples would probably be good.
@Waelthus
Copy link
Contributor

a central doc is envisioned for after Lya-1pt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement first_issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Waelthus @iprafols @andreicuceu