Skip to content

Commit 24fda56

Browse files
Merge pull request #14 from intercepted16/new-docs
docs: add proper documentation
2 parents 0cde499 + 13918d8 commit 24fda56

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# mtafoubs
2+
![alt text](docs/image.png)
3+
4+
`mtafoubs` is a simple Go CLI tool to move trash across Linux systems. It is inspired by `trash-cli`. Though, what makes it different is: it allows moving trash across fileystems; i.e: you can make your Trash directory a symlink to store it on a NAS! This saves space and allows you to keep trash for longer.
5+
6+
# Usage
7+
To use, simply run the compiled executable.
8+
9+
There are prebuilt executables provided on the Releases page.
10+
11+
However, if you compile it manually, it would still work.
12+
13+
# Compiling
14+
To compile, Go will take care of everything for you.
15+
16+
Just run:
17+
18+
```sh
19+
go build .
20+
```

docs/image.png

412 KB
Loading

0 commit comments

Comments
 (0)