Skip to content

docs: add flake instruction in readme #32

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

Merged
tomasriveral merged 1 commit into from
May 25, 2026
Merged

docs: add flake instruction in readme #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,26 @@ You must also have a [supported editor (and their associated plugin if needed)](

## How to install

### Nix flakes

Add this to your inputs in flake.nix:

```nix
notewrapper = {
url = "github:tomasriveral/notewrapper";
};
```
If your flake already inputs nixpkgs and/or flake-utils, you can follow it:
```nix
notewrapper = {
url = "github:tomasriveral/notewrapper;
inputs.nixpkgs.follow = "nixpkgs";
inputs.flake-utils.follow = "flake-utils";
};
```

### Building from source

1. Install all required dependencies listed above.
2. Ensure you have a supported editor installed.
3. Clone the repository:
Expand Down Expand Up @@ -89,7 +109,7 @@ make

---

## Packaging
### Packaging

There is currently no official package available for NoteWrapper.

Expand Down
Loading