Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

treat Nim 2.0 as targeted version; update former auditors guide link #23

Merged
merged 1 commit into from
Aug 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ jobs:
include:
- target:
os: linux
builder: ubuntu-20.04
builder: ubuntu-latest
shell: bash
- target:
os: macos
builder: macos-11
builder: macos-latest
shell: bash
- target:
os: windows
builder: windows-2019
builder: windows-latest
shell: msys2 {0}

defaults:
Expand All @@ -52,7 +52,7 @@ jobs:
with:
toolchain: '${{matrix.target.rust}}'
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Install build dependencies (Linux i386)
if: runner.os == 'Linux' && matrix.target.cpu == 'i386'
Expand Down Expand Up @@ -87,7 +87,7 @@ jobs:
- name: Restore Nim DLLs dependencies (Windows) from cache
if: runner.os == 'Windows'
id: windows-dlls-cache
uses: actions/cache@v2
uses: actions/cache@v3
with:
path: external/dlls-${{ matrix.target.cpu }}
key: 'dlls-${{ matrix.target.cpu }}'
Expand Down
11 changes: 7 additions & 4 deletions src/00_introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ When in doubt:

The latest version of this book can be found [online](https://status-im.github.io/nim-style-guide/) or on [GitHub](https://github.com/status-im/nim-style-guide/).

This guide currently targets Nim v1.6.
This guide currently targets Nim v2.0.

At the time of writing, v2.0 has been released but its new garbage collector is not yet stable enough for production use. It is advisable to test new code with both `--mm:gc` and `--mm:orc` (the default) in the transition period.
At the time of writing, v2.0 has been released but its new garbage collector is not yet stable enough for production use. It is advisable to test new code with both `--mm:refc` and `--mm:orc` (the default) in the transition period.

<!-- toc -->

Expand Down Expand Up @@ -58,8 +58,11 @@ In general, the guide will aim to prioritise:

While this book covers Nim at Status in general, there are other resources available that partially may overlap with this guide:

* [Nim manual](https://nim-lang.org/docs/manual.html) - the authorative source for understanding the features of the language
* [The Nimbus auditor book](https://nimbus.guide/auditors-book/) - covers the security details of Nimbus itself and how it relates to the features of Nim
* [Nim language manual](https://nim-lang.org/docs/manual.html) - the authorative source for understanding the features of the language
* [Nim documentation](https://nim-lang.org/documentation.html) - other official Nim documentation, including its standard library and toolchain
* [Nim by Example](https://nim-by-example.github.io/getting_started/) - Nim tutorials to start with
* [Chronos guides](https://github.com/status-im/nim-chronos/blob/master/docs/src/SUMMARY.md)
* [nim-libp2p docs](https://vacp2p.github.io/nim-libp2p/docs/)

## Workflow

Expand Down
2 changes: 1 addition & 1 deletion src/formatting.style.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ func someLongFunctinName(

### Practical notes

* We do not use `nimpretty` - as of writing (Nim 1.6), it is not stable enough for daily use:
* We do not use `nimpretty` - as of writing (Nim 2.0), it is not stable enough for daily use:
* Can break working code
* Naive formatting algorithm
* We do not make use of Nim's "flexible" identifier names - all uses of an identifier should match the declaration in capitalization and underscores
Expand Down
Loading