cli/README.md

61 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2023-10-05 07:58:30 +00:00
# dashinit
2023-10-05 07:34:44 +00:00
2023-10-05 07:58:30 +00:00
A nim-powered initializer that's fast, fully configurable, and effortlessly sets up your projects.
2023-10-05 07:34:44 +00:00
## Table of contents
2023-10-05 07:48:28 +00:00
- [Installation](#installation)
2023-10-05 08:00:36 +00:00
- [Package Manager](#package-manager)
- [Script](#script)
- [Compiling](#compiling)
2023-10-05 08:03:37 +00:00
- [Uninstalling](#uninstalling)
2023-10-05 07:48:28 +00:00
- [Update](#update)
- [Usage](#usage)
2023-10-05 07:58:30 +00:00
- [License](#license)
2023-10-05 07:34:44 +00:00
2023-10-05 07:48:28 +00:00
## Installation
2023-10-05 07:34:44 +00:00
2023-10-05 08:00:36 +00:00
### Package Manager
2023-10-05 07:59:44 +00:00
> **Note:** Currently not in a usable state. Instructions will be provided soon.
2023-10-05 08:00:36 +00:00
### Script
2023-10-05 07:34:44 +00:00
2023-10-05 07:58:30 +00:00
> **Note:** Currently not in a usable state. Instructions will be provided soon.
2023-10-05 07:34:44 +00:00
2023-10-05 08:00:36 +00:00
### Compiling
2023-10-05 07:48:28 +00:00
After cloning the repository, compile `dashinit` with the following command:
2023-10-05 07:34:44 +00:00
```bash
nim build
```
2023-10-05 08:03:37 +00:00
### 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.
2023-10-05 07:34:44 +00:00
## Update
2023-10-05 07:58:30 +00:00
> **Note:** Currently not in a usable state. Instructions will be provided soon.
2023-10-05 07:34:44 +00:00
## Usage
2023-10-05 07:48:28 +00:00
Execute `dashinit` inside the directory you wish to initialize. For detailed instructions, refer to:
```bash
dashinit -h
```
or
```bash
dashinit help
```
2023-10-05 07:34:44 +00:00
2023-10-05 07:58:30 +00:00
## License
This project is licensed under the GPLv3. For more information, see [LICENSE](LICENSE)
[↑ Back to Top](#dashinit)