diff --git a/README.md b/README.md index 1d6d5ac..f971289 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,30 @@ # niminit -Copies files from ``~/.config/niminit`` to ``.vscode`` in your current working directory. +Simple program that copies files from ``~/.config/niminit`` to ``.vscode`` in your current working directory and optionally initialises a Git repo. Written in nim! -## Compile & Use +Currently written to work for Linux, not tested on MacOS, Windows is unsupported for now (feel free to make a pull-request :D). + +## Table of contents +- [Install using script](#install-using-script) +- [Compile & install manually](#compile--install-manually) +- [Update](#update) +- [Usage](#usage) +- [Uninstall](#uninstall) + +## Install using script +Install using one-liner: +```bash +# Clone GitHub repo, compile and install niminit +git clone https://github.com/SangeloDev/niminit && cd niminit && chmod +x install.sh && ./install.sh +``` + +If you've cloned the repo already, you can also directly run install.sh: +```bash +$ ./install.sh +``` + +## Compile & install manually To compile ``niminit``, run the following command after cloning: ```bash @@ -12,8 +33,19 @@ nim c -o:bin/niminit niminit This will create a directory called ``bin/`` inside the repo. You can copy the binary into your path from there. -Currently written to work for Linux, not tested for MacOS, Windows is unsupported for now. +## Update +1. Open your terminal and ``cd`` into the repository. +2. Run ``git pull`` to update the local repo. +3. Run ``./install.sh`` again and enjoy! +## Usage To use niminit, run it inside the folder you'd like to initialise, after creating ``~/.config/niminit/`` and adding the files you'd like to copy there. Optionally, you can pass the ``-g`` flag to also create a git repository. + +## Uninstall +``niminit`` is self-contained, you can just remove the binary from ``~/.local/bin``. +``niminit`` also uses ``~/.config/niminit``, so remove that directory and you're done! + +--- +[Back to the top](#niminit) \ No newline at end of file diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..7259e80 --- /dev/null +++ b/install.sh @@ -0,0 +1,18 @@ +#!/bin/bash +# Install Script for niminit v1.0 +# (c) Sangelo, 2023 +# Read LICENSE for more info + +# Compile program +nim c -o:bin/niminit niminit + +# Create local bin folder if it doesn't exist +mkdir -p $HOME/.local/bin + +# Copy binary to local bin folder +cp bin/niminit $HOME/.local/bin/niminit + +# Print info message to export local bin if not already +echo -e "\n" +echo -e "\e[92m>>> \e[0mDone! If you haven't already added your local bin folder to your PATH, you can do so by adding the following line to your .profile, .bashrc or .zshrc" +echo -e "\e[1m\e[91mexport \e[0m\e[33m\$HOME./local/bin:\$PATH" \ No newline at end of file