mwojcik/assembly
1
0
Fork 0
forked from sinara-hw/assembly
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Repository with instructions and remarks on assembling and testing Sinara hardware
5 Commits 13 Branches 0 Tags 10 MiB
Python 59.5%
Nix 40.5%
3277359e7a
Go to file
Egor Savkin 3277359e7a Add contributing section into README 
Signed-off-by: Egor Savkin <es@m-labs.hk>
2023-02-06 15:56:22 +08:00
src Add phaser upconverter 2023-02-06 15:38:48 +08:00
.gitignore Init MDBook and Nix 2023-02-03 16:55:09 +08:00
book.toml Init MDBook and Nix 2023-02-03 16:55:09 +08:00
flake.lock Init MDBook and Nix 2023-02-03 16:55:09 +08:00
flake.nix 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 contributing section into README 2023-02-06 15:56:22 +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
  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)