Skip to content

Commit

Permalink
move docs (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
Schmluk committed Jun 15, 2024
1 parent 21c4e06 commit f111dd8
Show file tree
Hide file tree
Showing 9 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ sudo make install
```

## How to `config_utilities`
We provide detailed introductions about everything you need to know about `config_utilities` in the following [tutorials](config_utilities/docs/README.md#tutorials) and some verbose example [demos](config_utilities/docs/README.md#demos) that you can run.
We provide detailed introductions about everything you need to know about `config_utilities` in the following [tutorials](docs/README.md#tutorials) and some verbose example [demos](docs/README.md#demos) that you can run.

The (non-ros) demos can be run via the `run_demo.py` utility in the scripts directory. If you are building this library via catkin, you can run one of the following to see the results of one of the corresponding demo files:
```
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion config_utilities/docs/Parsing.md → docs/Parsing.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ MyConfig config = fromYamlFile<MyConfig>(file_path, "a/b/c");
> ```c++
> // Works! Expects the yaml data to contain a list of configs, e.g. [{config1 params}, {config2 params}, ...].
> std::vector<MyConfig> configs = fromYamlFile<std::vector<MyConfig>>(file_path, ns);
>
>
> // Works, too!
> VirtualConfig<MyBase> virtual_config = fromYaml<VirtualConfig<MyBase>>(file_path, ns);
> ```
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit f111dd8

Please sign in to comment.