forked from sinara-hw/assembly
Repository with instructions and remarks on assembling and testing Sinara hardware
linuswck
8d1432488f
Add assembly instructions for Shuttler Reviewed-on: sinara-hw/assembly#13 Co-authored-by: linuswck <linuswck@m-labs.hk> Co-committed-by: linuswck <linuswck@m-labs.hk> |
||
|---|---|---|
| src | ||
| .gitignore | ||
| book.toml | ||
| flake.lock | ||
| flake.nix | ||
| LICENSE | ||
| README.md | ||
sinara-assembly
Repository with instructions and remarks on assembling and testing Sinara hardware
Build docs
nix build
The output files are in result/book directory.
Development shell
nix develop
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:
- Compose a chapter in a new Markdown file in
src/hw - Add pictures if needed, store them in
src/img, assure them to be clear, informative and compressed (you can useconvert <INPUT IMAGE> -quality 80% -resize <width>x<height> <OUTPUT IMAGE>for optimizing JPEG image orconvert <INPUT IMAGE> -quality 80% -resize <width>x<height> -background white -alpha remove -alpha off <OUTPUT IMAGE>for images with transparent background) - Add link to the new chapter to the
src/SUMMARY.md - Do not forget to tell about all hidden/non-obvious obstacles and pitfalls
- Avoid using uncommon, complex, or hard-to-understand words, phrases, or grammar (e.g., ❌constituent -> ✔️component). Keep in mind that these guides may be used by people with different backgrounds and levels of English proficiency.
- Add testing steps, even the "obvious" ones
- Add JSON sample if needed
- Add hardware setup (e.g. pins, switches) steps if needed
- View changed and added pages with
mdbook build(see building instructions above)