From d367d8413b82adecaa1d707571a8aab41e39b0bf Mon Sep 17 00:00:00 2001 From: Robert Haimerl Date: Wed, 10 Apr 2024 09:49:24 +0200 Subject: [PATCH] fix broken config link --- README.md | 2 +- docs/Getting Started/configuration.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ee8bc5110..cb12e2b28 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ To actually run Codyze you must specify a subcommand: ```shell $ ./gradlew run --args="--config=config.json runCoko cokoCpg" ``` -This will run the `runCoko` subcommand with the `cokoCpg` backend using the demo config file [`./codyze-cli/config.json`](./codyze-cli/codyze.json). +This will run the `runCoko` subcommand with the `cokoCpg` backend using the demo config file [`./codyze-cli/config.json`](./codyze-cli/config.json). For more information, please refer to the [documentation](https://www.codyze.io). diff --git a/docs/Getting Started/configuration.md b/docs/Getting Started/configuration.md index db01e2821..aa3bde269 100644 --- a/docs/Getting Started/configuration.md +++ b/docs/Getting Started/configuration.md @@ -17,7 +17,7 @@ To append the data from the command line to the one from the configuration file, ## Configuration File The configurations can also be defined with a JSON configuration file. Use the option `--config=` to specify the path to the config file. -The configuration from `codyze.json` will always be loaded if no other file is specified. +The configuration from `./codyze.json` will always be loaded if no other file is specified. Relative paths in the configuration file are resolved relative to the configuration file location.