Repository with instructions and remarks on assembling and testing Sinara hardware. Doesn't pretend to be source of ultimate truth, and can change at any time.
Egor Savkin
0ad6b48185
Signed-off-by: Egor Savkin <es@m-labs.hk> |
||
|---|---|---|
| src | ||
| .gitignore | ||
| LICENSE | ||
| README.md | ||
| book.toml | ||
| flake.lock | ||
| flake.nix | ||
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
- 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)