Add contributing section into README
Signed-off-by: Egor Savkin <es@m-labs.hk>
This commit is contained in:
parent
c609e21f14
commit
3277359e7a
14
README.md
14
README.md
@ -19,3 +19,17 @@ mdbook build
|
|||||||
|
|
||||||
The output files are in `book` directory.
|
The output files are in `book` directory.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
If you found missing hardware or just want to add/enhance hints and instructions,
|
||||||
|
feel free to push them.
|
||||||
|
|
||||||
|
Tips for adding hardware instructions:
|
||||||
|
|
||||||
|
1. Compose a chapter in a new Markdown file in `src/hw`
|
||||||
|
2. Add pictures if needed, store them in `src/img`
|
||||||
|
3. Add link to the new chapter to the `src/SUMMARY.md`
|
||||||
|
4. Do not forget to tell about all hidden/non-obvious obstacles and pitfalls
|
||||||
|
5. Add testing steps, even if the "obvious" ones
|
||||||
|
6. Add JSON sample if needed
|
||||||
|
7. View changed and added pages with `mdbook build` (see building instructions above)
|
||||||
|
Loading…
Reference in New Issue
Block a user