Skip to content

Commit 5a8e349

Browse files
committed
Document running as Nix flake
1 parent 1025911 commit 5a8e349

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,19 +55,30 @@ Examples:
5555

5656
You can also run `maconomy get --help`, `maconomy set --help`, etc. to see more info on how to use each command.
5757

58-
## Installation
58+
## Running/installing
59+
60+
Requires a [configuration](#configuration).
61+
62+
### Option 1: running as a Nix flake
63+
64+
Requires having [Nix](https://github.com/NixOS/nix) installed [with flakes enabled](https://wiki.nixos.org/wiki/Flakes#Setup).
5965

6066
```sh
61-
git clone https://github.com/mawkler/maconomy-cli
62-
cargo install --path maconomy-cli/
67+
nix run github:mawkler/maconomy-cli --
6368
```
6469

65-
[Here's more information](https://doc.rust-lang.org/cargo/getting-started/installation.html) on how to install cargo (Rust's build-tool).
70+
### Option 2: installing with Cargo
6671

67-
### Dependencies
72+
Requires:
6873

74+
- [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
6975
- [Chromium](https://chromium.woolyss.com/download/) or Google Chrome (used in the current authentication implementation)
7076

77+
```sh
78+
git clone https://github.com/mawkler/maconomy-cli
79+
cargo install --path maconomy-cli/
80+
```
81+
7182
### Configuration
7283

7384
Configuration is done in the file `~/.config/maconomy-cli/config.toml`. Here's what the config file should look like. All fields except `cookie_path` are required:

0 commit comments

Comments
 (0)