-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
β
Updated README and added Install file
- Loading branch information
1 parent
fe12545
commit dcf4b76
Showing
2 changed files
with
86 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,51 @@ | ||
# sftm | ||
A fastπ easy to use Todo Manager in Rust π¦ | ||
# sftm (Super Fast Todo Manager) | ||
By Aeternus β’ *At* QUAKTECH | ||
|
||
<img src="https://avatars.githubusercontent.com/u/170379778?s=200&v=4" alt="QUAKTECH" width="100"/> | ||
|
||
|
||
βββββββββββββββββββββββββββββββββ | ||
|
||
## π Overview | ||
|
||
A fastπ, easy Todo Manager made with Rustπ¦ which will be apart of our up coming software suite. | ||
|
||
## π Software License | ||
|
||
- *MIT License* | ||
|
||
## Authors βοΈ | ||
- [Aeternus](https://github.com/Aeternusdio) | ||
|
||
βββββββββββββββββββββββββββββββββ | ||
|
||
## β¨ Features | ||
|
||
- Fast π | ||
- LightWight π¨ | ||
|
||
|
||
## π¦ Instalation | ||
|
||
```Shell | ||
$ git clone https://github.com/QUAKTECH/sftm | ||
$ cd sftm | ||
$ chmod +x install.sh | ||
$ ./install.sh | ||
``` | ||
Simple Idiot! | ||
|
||
|
||
## π Usage | ||
|
||
**Commands** : | ||
- add - Add a Todo [ $ sftm add "Buy Bananas" groceries ] | ||
- list - List all Todos [ $ sftm list ] | ||
- remove - Remove a Todo [ $ sftm remove 1 ] (1 is the index of the Todo, you also use -f to delete a file : $ sftm remove -f groceries) | ||
- version - Show the version of the program [ $ sftm version ] | ||
- check - Check a Todo [ $ sftm check 1 ] (1 is the index of the Todo) | ||
- show - Show a Todo file [ $ sftm show groceries ] | ||
|
||
|
||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
#!/bin/bash | ||
|
||
echo "Building project..." | ||
cargo build --release | ||
|
||
if [ $? -ne 0 ]; then | ||
echo "Build failed. Exiting." | ||
exit 1 | ||
fi | ||
|
||
if [ ! -f target/release/sftm ]; then | ||
echo "Error: target/release/sftm not found. Exiting." | ||
exit 1 | ||
fi | ||
|
||
TEMPLATE_TARGET_PATH="/home/$USER/.local/share/LICENSER/" | ||
mkdir -p "$TEMPLATE_TARGET_PATH" | ||
mv Templates/ "$TEMPLATE_TARGET_PATH" | ||
|
||
if [[ "$OSTYPE" == "darwin"* ]]; then | ||
echo "Detected macOS. Copying sftm to /usr/local/bin..." | ||
sudo cp target/release/sftm /usr/local/bin/ | ||
INSTALL_PATH="/usr/local/bin/sftm" | ||
else | ||
echo "Copying sftm to /usr/bin..." | ||
sudo cp target/release/sftm /usr/bin/ | ||
INSTALL_PATH="/usr/bin/sftm" | ||
fi | ||
|
||
if [ $? -ne 0 ]; then | ||
echo "Failed to copy sftm to $INSTALL_PATH. Exiting." | ||
exit 1 | ||
fi | ||
|
||
echo "sftm has been installed.π₯" |