mirror of
https://github.com/SangeloDev/niminit.git
synced 2024-11-09 10:52:38 +00:00
Sync dev branch with main (#1)
- Added Gitpot mirror to README - Mentioned possible need of resetting permissions when updating local git repo
This commit is contained in:
parent
f313efe86e
commit
8180427806
1 changed files with 17 additions and 11 deletions
26
README.md
26
README.md
|
@ -1,10 +1,12 @@
|
||||||
# niminit
|
# niminit
|
||||||
Simple program that copies files from ``~/.config/niminit`` to ``.vscode`` in your current working directory and optionally initialises a Git repo.
|
Simple program that copies files from `~/.config/niminit` to `.vscode` in your current working directory and optionally initialises a Git repo.
|
||||||
|
|
||||||
Written in nim!
|
Written in nim!
|
||||||
|
|
||||||
Currently written to work for Linux, not tested on MacOS, Windows is unsupported for now (feel free to make a pull-request :D).
|
Currently written to work for Linux, not tested on MacOS, Windows is unsupported for now (feel free to make a pull-request :D).
|
||||||
|
|
||||||
|
This repository is available on [Gitpot](https://gitpot.dev/sangelo/niminit) as a mirror!
|
||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
- [Install using script](#install-using-script)
|
- [Install using script](#install-using-script)
|
||||||
- [Compile & install manually](#compile--install-manually)
|
- [Compile & install manually](#compile--install-manually)
|
||||||
|
@ -15,7 +17,11 @@ Currently written to work for Linux, not tested on MacOS, Windows is unsupported
|
||||||
## Install using script
|
## Install using script
|
||||||
Install using one-liner:
|
Install using one-liner:
|
||||||
```bash
|
```bash
|
||||||
# Clone GitHub repo, compile and install niminit
|
# Clone the repo, compile and install niminit
|
||||||
|
|
||||||
|
## Clone from Gitpot
|
||||||
|
git clone https://gitpot.dev/sangelo/niminit && cd niminit && chmod +x install.sh && ./install.sh
|
||||||
|
## Clone from GitHub
|
||||||
git clone https://github.com/SangeloDev/niminit && cd niminit && chmod +x install.sh && ./install.sh
|
git clone https://github.com/SangeloDev/niminit && cd niminit && chmod +x install.sh && ./install.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -25,20 +31,20 @@ $ ./install.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
## Compile & install manually
|
## Compile & install manually
|
||||||
To compile ``niminit``, run the following command after cloning:
|
To compile `niminit`, run the following command after cloning:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
nim c -o:bin/niminit niminit
|
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.
|
This will create a directory called `bin/` inside the repo. You can copy the binary into your path from there.
|
||||||
|
|
||||||
You'll also find two template files that can be used to initialise a nim project for VSCode inside ``config`` in this repo. You can copy these to ``~/.config/niminit`` or create your own.
|
You'll also find two template files that can be used to initialise a nim project for VSCode inside `config` in this repo. You can copy these to `~/.config/niminit` or create your own.
|
||||||
|
|
||||||
## Update
|
## Update
|
||||||
1. Open your terminal and ``cd`` into the repository.
|
1. Open your terminal and `cd` into the repository.
|
||||||
2. Run ``git pull`` to update the local repo.
|
2. Run `git pull` to update the local repo.
|
||||||
3. Run ``./install.sh`` again and enjoy!
|
3. Run `./install.sh` again and enjoy! (You might have to make it executable again using `chmod +x install.sh`)
|
||||||
|
|
||||||
## Usage
|
## 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.
|
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.
|
||||||
|
@ -46,8 +52,8 @@ To use niminit, run it inside the folder you'd like to initialise, after creatin
|
||||||
Optionally, you can pass the ``-g`` flag to also create a git repository.
|
Optionally, you can pass the ``-g`` flag to also create a git repository.
|
||||||
|
|
||||||
## Uninstall
|
## Uninstall
|
||||||
``niminit`` is self-contained, you can just remove the binary from ``~/.local/bin``.
|
`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!
|
`niminit` also uses `~/.config/niminit`, so remove that directory and you're done!
|
||||||
|
|
||||||
---
|
---
|
||||||
[Back to the top](#niminit)
|
[Back to the top](#niminit)
|
Loading…
Reference in a new issue