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

Is it usefull to repeat the whole readme? #11

Closed
PyRowMan opened this issue Jul 26, 2019 · 3 comments
Closed

Is it usefull to repeat the whole readme? #11

PyRowMan opened this issue Jul 26, 2019 · 3 comments

Comments

@PyRowMan
Copy link
Contributor

I was thinking the best thing to do where to define that there is two types of examples in the main readme, and then point to two others readme in each example that would explain their specifications.

Originally posted by @bruno-ds in #9
@bruno-ds
Copy link
Contributor

I agree,
I would just like to try to let some content in the root doc. directory to avoid the necessity to update two files if something changes (I'm not really trustworthy when it come to this kind of things)

@PyRowMan
Copy link
Contributor Author

Yeah, that would be great to have a tree-ish documentation; It's easier to maintain.

@bruno-ds
Copy link
Contributor

bruno-ds commented Aug 6, 2019

done with b0a3fcd

@bruno-ds bruno-ds closed this as completed Aug 6, 2019
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
2 participants
@PyRowMan @bruno-ds