Skip to content

docs: adds nix to readme #791

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.

Sign up for GitHub

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

Open
raul-oliveira wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: adds nix to readme #791

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2bcf780
docs: adds nix to readme
raul-oliveira Jul 15, 2025
e13f354
Merge branch 'master' into raul-oliveira/update-readme-with-nix
raul-oliveira Mar 13, 2026
93368ba
Merge branch 'master' into raul-oliveira/update-readme-with-nix
raul-oliveira Mar 30, 2026
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
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,29 @@ A transaction is displayed.

### Prerequisites

#### Install nix (preferred)

For a better developer experience we suggest nix usage for managing the enviroment. Visit this [link](https://nixos.org/download/#download-nix) to download it.

To enable the commands `nix develop` and `nix build` using flakes, add the following to your `/etc/nix/nix.conf` file:

```
experimental-features = nix-command flakes
```
Comment on lines +37 to +39

@coderabbitai coderabbitai Bot Mar 13, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add language identifier to fenced code block.

Line 37 starts a fenced block without a language, which triggers markdown linting and reduces readability.

Suggested edit 
-```
+```conf
 experimental-features = nix-command flakes
</details>

<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 37-37: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 37 - 39, The fenced code block containing
"experimental-features = nix-command flakes" lacks a language identifier; update
the Markdown fenced block that surrounds that line (the triple-backtick block)
to include a language tag (e.g., use ```conf) so the block becomes a highlighted
"conf" code fence to satisfy the linter and improve readability.


#### Clone the project and install dependencies
```sh
$ git clone https://github.com/HathorNetwork/hathor-wallet.git
```
To initialize nix dev environment:
```sh
$ nix develop
Comment on lines +43 to +47

@coderabbitai coderabbitai Bot Mar 13, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Remove shell prompts from command blocks.

Line 43 and Line 47 include $ prompts without command output. Keeping only raw commands is cleaner and resolves MD014.

Suggested edit 
-$ git clone https://github.com/HathorNetwork/hathor-wallet.git
+git clone https://github.com/HathorNetwork/hathor-wallet.git
...
-$ nix develop
+nix develop
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 43-43: Dollar signs used before commands without showing output

(MD014, commands-show-output)

[warning] 47-47: Dollar signs used before commands without showing output

(MD014, commands-show-output)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 43 - 47, Remove the shell prompt characters from the
code blocks so the commands are raw: replace lines that start with "$ git clone
https://github.com/HathorNetwork/hathor-wallet.git" and "$ nix develop" with the
same commands but without the leading "$" (i.e., "git clone
https://github.com/HathorNetwork/hathor-wallet.git" and "nix develop") inside
the existing fenced code blocks to satisfy MD014.

```
then, install the depencies:
```sh
yarn
```

* Install node v22

### To install dependencies
Expand Down
Loading