https://status-im.github.io/nim-style-guide/
Status style guid for the Nim language
https://status-im.github.io/nim-style-guide/
Last synced: about 2 months ago
JSON representation
Status style guid for the Nim language
- Host: GitHub
- URL: https://status-im.github.io/nim-style-guide/
- Owner: status-im
- Created: 2021-01-27T07:30:32.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-26T06:29:24.000Z (9 months ago)
- Last Synced: 2024-11-09T20:21:12.679Z (8 months ago)
- Language: Nim
- Size: 1.52 MB
- Stars: 28
- Watchers: 20
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-nim - Nim Style Guide - Status style guide for the Nim language. (Resources / Books)
README
# Introduction
[Online version](https://status-im.github.io/nim-style-guide/)
An ever evolving collection of conventions, idioms and tricks that reflects the experience of developing a production-grade application in [Nim](https://nim-lang.org) with a small team of developers.
## Build and publish
The style guide is built using [mdBook](https://github.com/rust-lang/mdBook), and published to gh-pages using a github action.
```bash
# Install or update tooling (make sure you add "~/.cargo/bin" to PATH):
cargo install mdbook --version 0.4.36
cargo install mdbook-toc --version 0.14.1
cargo install mdbook-open-on-gh --version 2.4.1
cargo install mdbook-admonish --version 1.14.0
# Edit book and view through local browser
mdbook serve
```
## Contributing
We welcome contributions to the style guide as long as they match the strict security requirements Status places on Nim code. As with any style guide, some of it comes down to taste and we might reject them based on consistency or whim.