Skip to content

Commit 93bc554

Browse files
committed
docs: update changelog
1 parent 5044810 commit 93bc554

File tree

3 files changed

+74
-2
lines changed

3 files changed

+74
-2
lines changed

CHANGELOG.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Added
11+
12+
- **Flake package**: Added a Nix flake for packaging.
13+
14+
### Changed
15+
16+
- update documentation about installation and README
17+
1018
## [0.1.12] - 2025-09-11
1119

1220
### Changed
21+
1322
- **Improved variable naming**: Updated variable names to be more descriptive and consistent across the codebase.
1423
- **Changed the visibility**: Changed the visibility of the functions, methods, ... etc
1524
- Update documentation
@@ -19,7 +28,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1928
- **Conflicting trash items**: Updated logic to handle conflicts when recovering files with the same name.
2029
Now, if a file with the same name exists in the original location, the recovered file will be renamed with a timestamp suffix to avoid overwriting.
2130

22-
2331
## [0.1.11] - 2025-09-07
2432

2533
### Changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,22 @@ curl -fsSL https://raw.githubusercontent.com/santoshxshrestha/rmxt/main/scripts/
3737
cargo install rmxt
3838
```
3939

40+
### Nix Flake (for Nix users)
41+
42+
If you use Nix, you can run or build `rmxt` without installing Rust:
43+
44+
```bash
45+
nix run github:santoshxshrestha/rmxt
46+
```
47+
48+
Or build the binary:
49+
50+
```bash
51+
nix build github:santoshxshrestha/rmxt
52+
```
53+
54+
See the **[Installation Guide](docs/install.md)** for full details and prerequisites.
55+
4056
For detailed installation instructions including platform-specific setup, see the **[Installation Guide](docs/install.md)**.
4157

4258
## Basic Usage

docs/install.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,54 @@ sudo cp target/release/rmxt /usr/local/bin/
2121
curl -fsSL https://raw.githubusercontent.com/santoshxshrestha/rmxt/main/scripts/install.sh | bash
2222
```
2323

24+
## Using Nix Flakes
25+
26+
You can use [Nix flakes](https://nixos.wiki/wiki/Flakes) to run or build `rmxt` without installing Rust or any dependencies manually. This is the recommended method for Nix users.
27+
28+
**Prerequisites:**
29+
- [Nix package manager](https://nixos.org/download.html) (version 2.4+)
30+
- Flakes enabled (see [NixOS Wiki: Flakes](https://nixos.wiki/wiki/Flakes#Installing_flakes))
31+
32+
### Run `rmxt` directly (no install)
33+
34+
```bash
35+
nix run github:santoshxshrestha/rmxt
36+
```
37+
38+
Or, if you have cloned the repo:
39+
40+
```bash
41+
nix run .
42+
```
43+
44+
This will build and run the latest `rmxt` binary in a temporary environment.
45+
46+
### Build the binary
47+
48+
```bash
49+
nix build github:santoshxshrestha/rmxt
50+
```
51+
52+
Or, from a local clone:
53+
54+
```bash
55+
nix build
56+
```
57+
58+
The compiled binary will be available at `./result/bin/rmxt`.
59+
60+
### Development shell
61+
62+
For contributors, you can enter a shell with all development dependencies:
63+
64+
```bash
65+
nix develop
66+
```
67+
68+
### Notes
69+
- The provided flake currently supports `x86_64-linux`.
70+
- For more details on Nix flakes, see the [NixOS Wiki](https://nixos.wiki/wiki/Flakes) or [Practical Nix Flakes](https://serokell.io/blog/practical-nix-flakes).
71+
2472
## Verification
2573

2674
```bash
@@ -31,4 +79,4 @@ rmxt --help
3179

3280
```bash
3381
cargo install rmxt # Updates to latest version
34-
```
82+
```

0 commit comments

Comments
 (0)