diff --git a/README.md b/README.md index ad5cdc7..f96ee1d 100644 --- a/README.md +++ b/README.md @@ -36,11 +36,17 @@ 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 @@ -48,8 +54,6 @@ 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: diff --git a/docs/index.md b/docs/index.md index 94ed7c1..27c4c5d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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