Skip to content
Snippets Groups Projects
Verified Commit 3d3bf2ba authored by Daniel Hornung's avatar Daniel Hornung
Browse files

DOC: Renamed README_SETUP.md

parent 7748c0d9
No related branches found
No related tags found
1 merge request!35DOC: Make `make conan` more prominent.
Pipeline #19312 canceled
This commit is part of merge request !35. Comments created here will be created in the context of that merge request.
...@@ -7,8 +7,8 @@ for CaosDB and a part of the CaosDB project. ...@@ -7,8 +7,8 @@ for CaosDB and a part of the CaosDB project.
## Setup ## Setup
Please read the [README_SETUP.md](README_SETUP.md) for instructions on how to 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
develop, build and use this code. instructions on how to build, use and develop this code.
## Further Reading ## Further Reading
...@@ -20,7 +20,7 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md). ...@@ -20,7 +20,7 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md).
## License ## 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 All files in this repository are licensed under a [GNU Affero General Public
License](LICENCE.md) (version 3 or later). License](LICENCE.md) (version 3 or later).
doc/README_SETUP.md
\ No newline at end of file
...@@ -84,7 +84,7 @@ if (DOXYGEN_FOUND) ...@@ -84,7 +84,7 @@ if (DOXYGEN_FOUND)
sphinx_out sphinx_out
DEPENDS doc-doxygen DEPENDS doc-doxygen
Examples.rst Examples.rst
README_SETUP.md Install_develop.md
FEATURES.md FEATURES.md
CHANGELOG.md CHANGELOG.md
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
...@@ -94,7 +94,7 @@ if (DOXYGEN_FOUND) ...@@ -94,7 +94,7 @@ if (DOXYGEN_FOUND)
# Copying files is necessary: https://stackoverflow.com/a/45808534/232888 # Copying files is necessary: https://stackoverflow.com/a/45808534/232888
file(COPY file(COPY
Examples.rst Examples.rst
README_SETUP.md Install_develop.md
DEPENDENCIES.md DEPENDENCIES.md
CHANGELOG.md CHANGELOG.md
FEATURES.md FEATURES.md
......
...@@ -5,8 +5,8 @@ Examples ...@@ -5,8 +5,8 @@ Examples
Connect to a CaosDB server 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 See also the hints on how to :doc:`get started<Install_develop>`, and set-up of libcaosdb. In order
connect to a CaosDB server with libcaosdb you first have to configure the connection via a 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 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 Configuration>`. Once the configuration is set up, connecting to the server is as easy as
......
File moved
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = '@CMAKE_PROJECT_NAME@' project = '@CMAKE_PROJECT_NAME@'
copyright = '2021 IndiScale GmbH' copyright = '2022 IndiScale GmbH'
author = 'Timm Fitschen' author = 'Timm Fitschen'
version = '@CMAKE_PROJECT_VERSION@' version = '@CMAKE_PROJECT_VERSION@'
release = '@CMAKE_PROJECT_VERSION@' release = '@CMAKE_PROJECT_VERSION@'
......
...@@ -30,7 +30,7 @@ Welcome to |PROJECT_NAME|'s documentation! ...@@ -30,7 +30,7 @@ Welcome to |PROJECT_NAME|'s documentation!
:caption: Contents: :caption: Contents:
Welcome <self> Welcome <self>
Getting Started <README_SETUP> Getting Started <Install_develop>
Examples.rst Examples.rst
cppapi/index cppapi/index
capi/index capi/index
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment