architeuthis
/
assembly
forked from sinara-hw/assembly
1
0
Fork 0
Code Pull Requests Activity

Add contributing section into README 

Signed-off-by: Egor Savkin <es@m-labs.hk>
This commit is contained in:
Egor Savkin 2023-02-06 15:56:22 +08:00
parent c609e21f14
commit 3277359e7a
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -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)