Skip to content

Commit

Permalink
Clarify installation and usage
Browse files Browse the repository at this point in the history
  • Loading branch information
ad-si authored Feb 16, 2024
1 parent c3ee5c7 commit c992414
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,14 @@ But fear not, Oclis is here to help you out!

## Usage

1. Write a simple specification file.
2. Run `oclis` to generate the CLI parsing code for the language of your choice.
3. Define the handler functions for your commands.
4. Done 🎉
1. Install Oclis with
`cargo install oclis`
1. Create specifcation file skeleton with
`oclis init`
1. Manually edit the generated `oclis.ncl` file
1. Run `oclis build` to generate the CLI parsing code (automatically detects main repo language)
1. Define the handler functions for your commands.
1. Build and install your project 🎉


## How It Works
Expand Down

0 comments on commit c992414

Please sign in to comment.