sinara-hw
/
assembly
5
3
Fork 6
Code Issues 5 Pull Requests Packages Projects Releases Activity
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.
55 Commits 4 Branches 0 Tags 10 MiB
Python 77.5%
Nix 22.5%
Go to file
Egor Savkin a4c9061934 Add direct connection manual and update flake 
Signed-off-by: Egor Savkin <es@m-labs.hk>
 		2023-10-25 11:08:35 +08:00
src Add direct connection manual and update flake 2023-10-25 11:08:35 +08:00
.gitignore Init MDBook and Nix 2023-02-03 16:55:09 +08:00
LICENSE Initial commit 2023-02-03 16:13:18 +08:00
README.md Add clocker, grabber (draft), almazny, sampler, fastino, master-satellite instructions 2023-02-13 14:15:36 +08:00
book.toml Init MDBook and Nix 2023-02-03 16:55:09 +08:00
flake.lock Add direct connection manual and update flake 2023-10-25 11:08:35 +08:00
flake.nix Add direct connection manual and update flake 2023-10-25 11:08:35 +08:00

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:

  1. Compose a chapter in a new Markdown file in src/hw
  2. Add pictures if needed, store them in src/img, assure them to be clear, informative and compressed (you can use convert <INPUT IMAGE> -quality 80% -resize <width>x<height> <OUTPUT IMAGE> for optimizing JPEG image or convert <INPUT IMAGE> -quality 80% -resize <width>x<height> -background white -alpha remove -alpha off <OUTPUT IMAGE> for images with transparent background)
  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 the "obvious" ones
  6. Add JSON sample if needed
  7. Add hardware setup (e.g. pins, switches) steps if needed
  8. View changed and added pages with mdbook build (see building instructions above)