60 lines
1.2 KiB
Markdown
60 lines
1.2 KiB
Markdown
# dashinit
|
|
|
|
A nim-powered initializer that's fast, fully configurable, and effortlessly sets up your projects.
|
|
|
|
## Table of contents
|
|
|
|
- [Installation](#installation)
|
|
- [Package Manager](#package-manager)
|
|
- [Script](#script)
|
|
- [Compiling](#compiling)
|
|
- [Uninstalling](#uninstalling)
|
|
- [Update](#update)
|
|
- [Usage](#usage)
|
|
- [License](#license)
|
|
|
|
## Installation
|
|
|
|
### Package Manager
|
|
|
|
> **Note:** Currently not in a usable state. Instructions will be provided soon.
|
|
|
|
### Script
|
|
|
|
> **Note:** Currently not in a usable state. Instructions will be provided soon.
|
|
|
|
### Compiling
|
|
|
|
After cloning the repository, compile `dashinit` with the following command:
|
|
|
|
```bash
|
|
nim build
|
|
```
|
|
|
|
### Uninstalling
|
|
|
|
Uninstalling dashinit should be simple, as it's a self-contained binary. Just delete the binary and configuration directory and you're good to go.
|
|
|
|
## Update
|
|
|
|
> **Note:** Currently not in a usable state. Instructions will be provided soon.
|
|
|
|
## Usage
|
|
|
|
Execute `dashinit` inside the directory you wish to initialize. For detailed instructions, refer to:
|
|
|
|
```bash
|
|
dashinit -h
|
|
```
|
|
|
|
or
|
|
|
|
```bash
|
|
dashinit help
|
|
```
|
|
|
|
## License
|
|
|
|
This project is licensed under the GPLv3. For more information, see [LICENSE](LICENSE)
|
|
|
|
[↑ Back to Top](#dashinit)
|