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

Improve the README #183

Open
jordanmontt opened this issue Feb 21, 2023 · 3 comments
Open

Improve the README #183

jordanmontt opened this issue Feb 21, 2023 · 3 comments

Comments

@jordanmontt
Copy link
Collaborator

jordanmontt commented Feb 21, 2023 •
edited
Loading

(Edited)
It would be nice to have some examples of how to get start in the README file. Also a quick getting started code snippet. And give a pass to the Readme in general :)
@Ducasse
Copy link

Ducasse commented Feb 21, 2023

Remember that in P11 you will be able to read the documentation that is located in the doc folder.

S

@jordanmontt
Copy link
Collaborator Author

Yes, that is why we want to have a good README file with good documentation :)

@jordanmontt jordanmontt changed the title Add quick starting example on the README Improve the README Feb 22, 2023
@jecisc
Copy link
Member

jecisc commented Mar 6, 2023

A quick start should be enough because there is a booklet with much more documentation provided also

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

No branches or pull requests
3 participants
@Ducasse @jecisc @jordanmontt