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

Split and streamline information in README #206

Closed
rhugonnet opened this issue Sep 3, 2021 · 1 comment
Closed

Split and streamline information in README #206

rhugonnet opened this issue Sep 3, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@rhugonnet
Copy link
Member

rhugonnet commented Sep 3, 2021 •
edited
Loading

Just a minor thought, but should we not have a dedicated INSTALL file or so with all these considerations. I feel like this is not the best use of the README, which should be rather clear and concise. What do you think?

Fully agreed, there is quite a bit of work on the README to make it a more agreeable read for users. I think we should focus more on the DEM thematic and a couple examples with clear links to documentation rather than all the coding stuff (how to contribute, how to install, etc... should live in separate files simply referred in the README).

Originally posted by @rhugonnet in #200 (comment)
@adehecq adehecq added the documentation Improvements or additions to documentation label Oct 13, 2021
@rhugonnet rhugonnet mentioned this issue Apr 23, 2022
Merged
@rhugonnet
Copy link
Member Author

Solved by #303

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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@adehecq @rhugonnet