Skip to content

Commit

Permalink
other: Prettified README.md in CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
Luna-Klatzer committed Jul 1, 2024
1 parent 5709e09 commit 760356a
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions kipper/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@ and the [Kipper website](https://kipper-lang.org)._
[![DOI](https://zenodo.org/badge/411260595.svg)](https://zenodo.org/badge/latestdoi/411260595)

<!-- toc -->
* [Kipper CLI - `@kipper/cli` 🦊✨](#kipper-cli---kippercli-)
* [Usage](#usage)
* [Commands](#commands)

- [Kipper CLI - `@kipper/cli` 🦊✨](#kipper-cli---kippercli-)
- [Usage](#usage)
- [Commands](#commands)
<!-- tocstop -->

## General Information
Expand All @@ -39,6 +40,7 @@ and the [Kipper website](https://kipper-lang.org)._
# Usage

<!-- usage -->

```sh-session
$ npm install -g @kipper/cli
$ kipper COMMAND
Expand All @@ -50,17 +52,19 @@ USAGE
$ kipper COMMAND
...
```

<!-- usagestop -->

# Commands

<!-- commands -->
* [`kipper analyse [FILE]`](#kipper-analyse-file)
* [`kipper compile [FILE]`](#kipper-compile-file)
* [`kipper help [COMMAND]`](#kipper-help-command)
* [`kipper new [LOCATION]`](#kipper-new-location)
* [`kipper run [FILE]`](#kipper-run-file)
* [`kipper version`](#kipper-version)

- [`kipper analyse [FILE]`](#kipper-analyse-file)
- [`kipper compile [FILE]`](#kipper-compile-file)
- [`kipper help [COMMAND]`](#kipper-help-command)
- [`kipper new [LOCATION]`](#kipper-new-location)
- [`kipper run [FILE]`](#kipper-run-file)
- [`kipper version`](#kipper-version)

## `kipper analyse [FILE]`

Expand Down Expand Up @@ -207,6 +211,7 @@ USAGE
```

_See code: [src/commands/version.ts](https://github.com/Kipper-Lang/Kipper/blob/v0.11.0-alpha.5/kipper/cli/src/commands/version.ts)_

<!-- commandsstop -->

## Contributing to Kipper
Expand Down

0 comments on commit 760356a

Please sign in to comment.