From 3277359e7a7f9da3f0474f0616de9e6a01bb3285 Mon Sep 17 00:00:00 2001 From: Egor Savkin Date: Mon, 6 Feb 2023 15:56:22 +0800 Subject: [PATCH] Add contributing section into README Signed-off-by: Egor Savkin --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 98a512a..3f532c2 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,17 @@ mdbook build 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)