mirror of
https://github.com/SangeloDev/niminit.git
synced 2024-11-09 10:52:38 +00:00
Update README & create install script
This commit is contained in:
parent
67fdb77a0d
commit
6131b3ca58
2 changed files with 53 additions and 3 deletions
38
README.md
38
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)
|
18
install.sh
Executable file
18
install.sh
Executable file
|
@ -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"
|
Loading…
Reference in a new issue