1
0
Fork 0
sinara-hw-assembly/README.md

36 lines
865 B
Markdown
Raw Normal View History

2023-02-03 16:13:18 +08:00
# sinara-assembly
Repository with instructions and remarks on assembling and testing Sinara hardware
### Build docs
```shell
nix build
```
The output files are in `result/book` directory.
### Development shell
```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)