mkml 0.1.4

A CLI app to quickly initialize basic HTML projects
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# mkml

mkdl is a simple, cross-platform(?), command written in Rust to initialize a simple
HTML website project with organisation.

This project is in very early stages of developments and some stuff
are not complete; for example, selecting a log level flag will not do anything yet.

# Usage

```
USAGE:
    mkml [OPTIONS] <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -l, --log        Set the logging level: 0: No logging, 1: Debug, 2: Info, 3: Warning, 4: Error
    -V, --version    Print version information

SUBCOMMANDS:
    help    Print this message or the help of the given subcommand(s)
    init    Create a HTML project
```

# Installing
If you just want the latest executable binary, you can install them without
having to build anything from the [release page](https://github.com/rohankid1/mkml/releases); however, the page may not always contain the
latest release so it's better to build from source.

If you're a Rust developer, you can simply run the command to install it:
```
cargo install mkml --release
```

# Building from source
## Prerequisites 
* Rustc
* Cargo

Rustc and Cargo can be installed from [here](https://www.rust-lang.org/tools/install)

To build from source, simply clone this repository.
You can clone the repository by running the following command:
`git clone https://github.com/rohankid1/mkml.git`

Alternatively, you can download the zip file containing the source code by clicking
on the button labelled "Code". Then click on `Download ZIP`.

Once done, `cd` into the folder. It's time for building!

For developers wanting to add their own features, you can edit the source
code directly and run cargo r (short for cargo run) to test it in dev
mode. The debug binary will be located in `target/debug/`
For users who just want to use the program: run `cargo build --release`.
Since this project is not a large project, it will take a short time to
finish compiling.

Once it has finished compiling, the executable should have been created in
target/release/. The binary's name is `mkml` on Linux and `mkml.exe` on Windows.
For Linux users, you have to run it through the terminal. Also, for quick access,
you should copy or move the binary to `/usr/local/bin` - that way you can just run `mkml`
and not something like `Downloads/mkml/target/release/mkml`. You can simply do this by running
`sudo cp path/to/mkml /usr/local/bin` or mv instead of cp if you want to move it.