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 some documentation #18

Closed
giordano opened this issue Mar 30, 2020 · 4 comments · Fixed by #20
Closed

Add some documentation #18

giordano opened this issue Mar 30, 2020 · 4 comments · Fixed by #20
Assignees
@tkoskela
Labels
documentation Improvements or additions to documentation

Comments

@giordano
Copy link
Member

We don't have much user documentation. We should at least explain the main user interface and clearly document the parameters and how to write the YAML file (what are the allowed parameters, units, etc...)
@tkoskela
Copy link
Member

Should this be in README?

@giordano
Copy link
Member Author

giordano commented Mar 30, 2020 •
edited
Loading

That's a good starting point. We could have some docs hosted on github pages, but I don't know the setup to make this work with a private repo

@tkoskela
Copy link
Member

tkoskela commented Mar 30, 2020 •
edited
Loading

I can start adding some documentation

@tkoskela tkoskela added the documentation Improvements or additions to documentation label Apr 1, 2020
@tkoskela tkoskela self-assigned this Apr 1, 2020
tkoskela added a commit that referenced this issue Apr 3, 2020
@tkoskela
Update README.md
a920c86 
Adding more usage documentation to README to address #18.
@tkoskela tkoskela mentioned this issue Apr 3, 2020
Merged
@tkoskela
Copy link
Member

tkoskela commented May 6, 2020

Closing this, let's open new ones if we get user feedback.

@tkoskela tkoskela closed this as completed May 6, 2020
@giordano giordano linked a pull request Jun 16, 2020 that will close this issue
Update README.md #20
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tkoskela tkoskela

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update README.md Team-RADDISH/ParticleDA.jl
2 participants
@giordano @tkoskela