Update README.md

This commit is contained in:
Sangelo 2023-10-05 09:48:28 +02:00
parent b1c86f50c8
commit 99b53883d9

View file

@ -1,42 +1,50 @@
# dashinit
# Dashinit
Simple, yet powerful, Nim powered templating tool. Fully configurable!
A nim-powered templating tool that's simple yet powerful. Fully configurable!
## Table of contents
- [dashinit](#dashinit)
- [Table of contents](#table-of-contents)
- [Install using script](#install-using-script)
- [Compile \& install manually](#compile--install-manually)
- [Update](#update)
- [Usage](#usage)
- [Uninstall](#uninstall)
- [Installation](#installation)
- [Using Script](#using-script)
- [Manual Compilation \& Installation](#manual-compilation--installation)
- [Update](#update)
- [Usage](#usage)
- [Uninstall](#uninstall)
## Install using script
## Installation
Still not in usable state, instructions will follow.
### Using Script
## Compile & install manually
> Note: Currently not in a usable state. Instructions will be provided soon.
To compile `dashinit`, run the following command after cloning:
### Manual Compilation & Installation
After cloning the repository, compile `dashinit` with the following command:
```bash
# build a binary
nim build
```
## Update
Still not in usable state, instructions will follow.
> Note: Currently not in a usable state. Instructions will be provided soon.
## Usage
To use niminit, run it inside the folder you'd like to initialise.
For more info, see `dashinit -h` or `dashinit help`
Execute `dashinit` inside the directory you wish to initialize. For detailed instructions, refer to:
```bash
dashinit -h
```
or
```bash
dashinit help
```
## Uninstall
Still not in usable state, instructions will follow.
> Note: Currently not in a usable state. Instructions will be provided soon.
---
[Back to the top](#dashinit)
[🔝 Back to Top](#dashinit)