Skip to content

Commit

Permalink
Improved docs (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
fpgmaas committed Mar 27, 2023
1 parent 1d0fa3b commit bed026e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,24 @@ pip install ckit

To get started, run

```shell
```bash
ckit init
```

which will prompt to add a `ckit/ckit.yaml` file in the user's home directory for global commands, and/or a `ckit.yaml` file in the current directory for commands specific to the current project.
which will prompt to add a `ckit/ckit.yaml` file in the user's home directory for global commands, and/or a `ckit.yaml` file in the current directory for commands specific to the current project. Alternatively, run

```bash
ckit init --download-global-defaults
```

to get started with a richer set of examples in the global configuration directory, see [ckit-files](https://github.com/fpgmaas/ckit-files/).

To use _ckit_ to run any of the pre-configured commands, simply run

```
ckit
```

For more information, see the [documentation](https://fpgmaas.github.io/ckit/).

## Configuration

_ckit_ can look for configuration in the following two locations:
Expand Down
8 changes: 7 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,13 @@ To get started, run
ckit init
```

which will prompt to add a `ckit/ckit.yaml` file in the user's home directory (or the directory specified by the environment variable `CKIT_HOME`) for global commands, and/or a `ckit.yaml` file in the current directory for commands specific to the current project.
which will prompt to add a `ckit/ckit.yaml` file in the user's home directory for global commands, and/or a `ckit.yaml` file in the current directory for commands specific to the current project. Alternatively, run

```bash
ckit init --download-global-defaults
```

to get started with a richer set of examples in the global configuration directory, see [ckit-files](https://github.com/fpgmaas/ckit-files/).

To use _ckit_ to run any of the pre-configured commands, simply run

Expand Down

0 comments on commit bed026e

Please sign in to comment.