diff --git a/README.md b/README.md index 633c19e4aac1d84928bdc63f951b290923925da6..06b388694c90eef67ec6b14dcfcddcf2260b6fd7 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@ for CaosDB and a part of the CaosDB project. ## Setup -Please read the [README_SETUP.md](README_SETUP.md) for instructions on how to -develop, build and use this code. +Please read the installation instructions [online](https://docs.indiscale.com/caosdb-cpplib/Install_develop.html) or [in the source repository](doc/Install_develop.md) for +instructions on how to build, use and develop this code. ## Further Reading @@ -20,7 +20,7 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md). ## License -* Copyright (C) 2021 Indiscale GmbH <info@indiscale.com> +* Copyright (C) 2022 Indiscale GmbH <info@indiscale.com> All files in this repository are licensed under a [GNU Affero General Public License](LICENCE.md) (version 3 or later). diff --git a/README_SETUP.md b/README_SETUP.md deleted file mode 120000 index c5c7270fb583274df037848bfb735cdb48829d28..0000000000000000000000000000000000000000 --- a/README_SETUP.md +++ /dev/null @@ -1 +0,0 @@ -doc/README_SETUP.md \ No newline at end of file diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index e047833099812cadf7c3575aa45e235f0e20d9c6..a1e46806012540a800917d8e80753b1c28e5d5fb 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -84,7 +84,7 @@ if (DOXYGEN_FOUND) sphinx_out DEPENDS doc-doxygen Examples.rst - README_SETUP.md + Install_develop.md FEATURES.md CHANGELOG.md WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} @@ -94,7 +94,7 @@ if (DOXYGEN_FOUND) # Copying files is necessary: https://stackoverflow.com/a/45808534/232888 file(COPY Examples.rst - README_SETUP.md + Install_develop.md DEPENDENCIES.md CHANGELOG.md FEATURES.md diff --git a/doc/Examples.rst b/doc/Examples.rst index 9bc08444b1ca88ddc1feee85e632351d1dba4661..1bf62f31a05bccd9e168be22a1c2d12d6873f325 100644 --- a/doc/Examples.rst +++ b/doc/Examples.rst @@ -5,8 +5,8 @@ Examples Connect to a CaosDB server -------------------------- -See also the hints on how to :doc:`get started<README_SETUP>`, and set-up of libcaosdb. In order to -connect to a CaosDB server with libcaosdb you first have to configure the connection via a +See also the hints on how to :doc:`get started<Install_develop>`, and set-up of libcaosdb. In order +to connect to a CaosDB server with libcaosdb you first have to configure the connection via a configuration file as explained in the :ref:`"Client Configuration" section <Client Configuration>`. Once the configuration is set up, connecting to the server is as easy as diff --git a/doc/README_SETUP.md b/doc/Install_develop.md similarity index 100% rename from doc/README_SETUP.md rename to doc/Install_develop.md diff --git a/doc/conf.py.in b/doc/conf.py.in index 202d9d294c01dba07818c7a5efb2fbb65dec7840..0490a20abe04a6ad027eff36fcc9d1fe4939cb4e 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- project = '@CMAKE_PROJECT_NAME@' -copyright = '2021 IndiScale GmbH' +copyright = '2022 IndiScale GmbH' author = 'Timm Fitschen' version = '@CMAKE_PROJECT_VERSION@' release = '@CMAKE_PROJECT_VERSION@' diff --git a/doc/index.rst.in b/doc/index.rst.in index 5828a70ffe23433156e4a04cbf112d8e27574004..b6fdaaf592f8fe4e36008a509204a10d23d3e320 100644 --- a/doc/index.rst.in +++ b/doc/index.rst.in @@ -30,7 +30,7 @@ Welcome to |PROJECT_NAME|'s documentation! :caption: Contents: Welcome <self> - Getting Started <README_SETUP> + Getting Started <Install_develop> Examples.rst cppapi/index capi/index