Skip to content

Commit 0b3bf8a

Browse files
committed
docs: update install instructions, add uninstall guide, and reference uninstall in README
1 parent 67ea9d4 commit 0b3bf8a

File tree

3 files changed

+72
-0
lines changed

3 files changed

+72
-0
lines changed

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Simple, focused guides for rmxt.
55
## Files
66

77
- **[install.md](install.md)** - Installation methods
8+
- **[uninstall.md](uninstall.md)** - Uninstallation instructions
89
- **[usage.md](usage.md)** - Basic usage and examples
910
- **[advanced.md](advanced.md)** - Shell integration, automation, troubleshooting
1011

docs/install.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,26 @@ sudo cp target/release/rmxt /usr/local/bin/
1717

1818
## Using Install Script
1919

20+
You can use the provided install script to automate installation. It will:
21+
- Ensure Rust is installed
22+
- Clone the repository to `$HOME/rmxt`
23+
- Build the binary
24+
- Install it to `/usr/local/bin/rmxt`
25+
2026
```bash
2127
curl -fsSL https://raw.githubusercontent.com/santoshxshrestha/rmxt/main/scripts/install.sh | bash
2228
```
2329

30+
### Script Options
31+
- `--dry-run` : Show what would be done without making changes
32+
- `--repo=URL` : Use a custom repository URL
33+
- `-h, --help` : Show help message
34+
35+
Example:
36+
```bash
37+
bash scripts/install.sh --dry-run
38+
```
39+
2440
## Using Nix Flakes
2541

2642
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.

docs/uninstall.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Uninstallation
2+
3+
This guide explains how to completely remove `rmxt` from your system.
4+
5+
## Quick Uninstall (Recommended)
6+
7+
You can use the provided uninstall script to remove both the binary and the cloned repository:
8+
9+
```bash
10+
curl -fsSL https://raw.githubusercontent.com/santoshxshrestha/rmxt/main/scripts/uninstall.sh | bash
11+
```
12+
13+
### Script Options
14+
- `--dry-run` : Show what would be removed without making changes
15+
- `-h, --help` : Show help message
16+
17+
Example:
18+
```bash
19+
bash scripts/uninstall.sh --dry-run
20+
```
21+
22+
## Manual Uninstall
23+
24+
If you prefer to remove files manually:
25+
26+
1. **Remove the binary**
27+
```bash
28+
sudo rm -f /usr/local/bin/rmxt
29+
```
30+
2. **Remove the cloned repository** (if you installed from source or script)
31+
```bash
32+
rm -rf "$HOME/rmxt"
33+
```
34+
35+
## Nix Uninstall
36+
37+
If you installed via Nix flakes, remove the build result:
38+
```bash
39+
rm -rf ./result
40+
```
41+
Or use Nix commands to clean up:
42+
```bash
43+
nix profile remove github:santoshxshrestha/rmxt
44+
```
45+
46+
## Verification
47+
48+
Check that `rmxt` is no longer available:
49+
```bash
50+
which rmxt
51+
# Should return nothing
52+
```
53+
54+
---
55+
For any issues, see [advanced.md](advanced.md) or open an issue on GitHub.

0 commit comments

Comments
 (0)