cli/README.md

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)
- [Using a package manager](#using-a-package-manager)
- [Using Script](#using-script)
- [Manual Compilation \& Installation](#manual-compilation--installation)
- [Update](#update)
- [Usage](#usage)
- [Uninstall](#uninstall)
- [License](#license)
## Installation
### Using a package manager
> **Note:** Currently not in a usable state. Instructions will be provided soon.
### Using Script
> **Note:** Currently not in a usable state. Instructions will be provided soon.
### Manual Compilation & Installation
After cloning the repository, compile `dashinit` with the following command:
```bash
nim build
```
## 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
```
## Uninstall
> **Note:** Currently not in a usable state. Instructions will be provided soon.
## License
This project is licensed under the GPLv3. For more information, see [LICENSE](LICENSE)
[↑ Back to Top](#dashinit)