Split documentation between several files #5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
hi @Eulbobo, Maybe create a |
Author
|
I'll make another version soon (up to date), in a doc folder |
Eulbobo
force-pushed
the
doc
branch
2 times, most recently
from
849f73e to
e0d7b7b
Compare
Author
|
Documentation up-to-date and split into multiple files to enhance readability |
cedvan
suggested changes
Nov 30, 2017
| It is not a standalone project, so it must be used in the context of an another project. | ||
|
|
||
| ## TL;DR | ||
| ## Quick Start |
README.md
Outdated
| To run them, just do `make tests`. | ||
| Please, do not omit to update tests before implemeting new feature or doing a bug fix. | ||
| To update tests, just update the content of the `references` directory. | ||
| If you want to contribute, please refer to the [Contribution](doc/Contributing.md) section |
Contributor
There was a problem hiding this comment.
Contributing.md must be in root folder ;)
cedvan
approved these changes
Nov 30, 2017
mageekguy
changed the title
Contributor
|
Hi! |
Contributor
|
+1 for split documentation |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.