diff --git a/README.md b/README.md index dc3443d..fa2ed6c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,51 @@ -# sftm -A fastπŸš€ easy to use Todo Manager in Rust πŸ¦€ +# sftm (Super Fast Todo Manager) +By Aeternus β€’ *At* QUAKTECH + +QUAKTECH + + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +## πŸ“‹ 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 ] + + + +--- \ No newline at end of file diff --git a/install.sh b/install.sh new file mode 100644 index 0000000..4e6e146 --- /dev/null +++ b/install.sh @@ -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.πŸ”₯" \ No newline at end of file