fprime
fprime copied to clipboard
nasa
Refactor README.md
| F´ Version | |
| Affected Component |
Problem Description
Users are discovering F´ via the github repo directly (as opposed to the documentation landing page). This is causing difficulty in finding and running the installation instructions.
We should look into refactoring the README so it has a similar flow (or links to) our documentation.
@gjwatney feel free to provide specific thoughts here, or direct them to me directly.
In discussing this further, the README.md page here should highlight a link to the documentation Home and Getting Started pages. It should otherwise be minimal. To be precise:
- Short intro paragraph (what is F´). Must be succinct.
- Links to
Documentation HomeandGetting Started - Links to release notes
I personally find that there is too much text that loses the reader and could be made more succinct - the details could be put elsewhere. If visitors don't understand visually how to implement the framework in 10 seconds, they will pass by.
An example would be either code snippets, or even better a gif like this: https://github.com/ajeetdsouza/zoxide#getting-started And putting the project logo on the README would make the project more welcoming.
Note: I presented the framework to four trainees and none of them understood what it was concretely from the README. After explaining it orally, they all told me that the README should be more user-friendly, welcoming and show concretely the lines of code to write to use the project (a kind of TLTR).
Hi, I would really like to contribute to this as part of Hacktoberfest! I just started out in open-source development and want to help as much as possible. Please let me know how to get started and I will put my best into it. :) Thank you!!
