cli/README.md
2023-10-05 10:00:36 +02:00

60 lines
1.1 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)
- [Update](#update)
- [Usage](#usage)
- [Uninstall](#uninstall)
- [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
```
## 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)