diff --git a/README.md b/README.md index 344f905..9149dc9 100644 --- a/README.md +++ b/README.md @@ -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: ``` diff --git a/config_utilities/docs/Advanced.md b/docs/Advanced.md similarity index 100% rename from config_utilities/docs/Advanced.md rename to docs/Advanced.md diff --git a/config_utilities/docs/Configs.md b/docs/Configs.md similarity index 100% rename from config_utilities/docs/Configs.md rename to docs/Configs.md diff --git a/config_utilities/docs/Factories.md b/docs/Factories.md similarity index 100% rename from config_utilities/docs/Factories.md rename to docs/Factories.md diff --git a/config_utilities/docs/Headers.md b/docs/Headers.md similarity index 100% rename from config_utilities/docs/Headers.md rename to docs/Headers.md diff --git a/config_utilities/docs/Parsing.md b/docs/Parsing.md similarity index 99% rename from config_utilities/docs/Parsing.md rename to docs/Parsing.md index 1305796..0aea783 100644 --- a/config_utilities/docs/Parsing.md +++ b/docs/Parsing.md @@ -42,7 +42,7 @@ MyConfig config = fromYamlFile(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 configs = fromYamlFile>(file_path, ns); -> +> > // Works, too! > VirtualConfig virtual_config = fromYaml>(file_path, ns); > ``` diff --git a/config_utilities/docs/README.md b/docs/README.md similarity index 100% rename from config_utilities/docs/README.md rename to docs/README.md diff --git a/config_utilities/docs/Types.md b/docs/Types.md similarity index 100% rename from config_utilities/docs/Types.md rename to docs/Types.md diff --git a/config_utilities/docs/Varia.md b/docs/Varia.md similarity index 100% rename from config_utilities/docs/Varia.md rename to docs/Varia.md