Verified Commit 4dceb8e2 authored by SZPYRKA Jean-Luc's avatar SZPYRKA Jean-Luc
Browse files

renaming & first doc

parent d3dfda60
Pipeline #130886 passed with stage
in 4 minutes and 29 seconds
......@@ -44,7 +44,7 @@ PROJECT_NUMBER = @PROJECT_SHORT_VERSION@
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = "dtkCore is a C++ API dedicated to ..."
PROJECT_BRIEF = "dtk is a C++ layer collection dedicated to ..."
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
......@@ -1122,7 +1122,7 @@ COLS_IN_ALPHA_INDEX = 5
# while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
IGNORE_PREFIX = dtk
IGNORE_PREFIX = dtk dtkCore dtkWidgets
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
......
About dtkCore
--------------
dtkCore is developped and maintained by sed-sophia@inria.fr
dtk is developped and maintained by sed-sam@inria.fr
......@@ -4,7 +4,9 @@ Compile from the sources
Download
^^^^^^^^
dtkCore sources are available on: https://gitlab.inria.fr/dtk/dtk-core
All dtk layers are available on gitlab.inria.fr at: https://gitlab.inria.fr/dtk
For example, dtkCore sources are available on: https://gitlab.inria.fr/dtk/dtk-core
Last release is available in the master branch at:
......@@ -16,13 +18,19 @@ or
Compile
^^^^^^^
Compile a specific layer
^^^^^^^^^^^^^^^^^^^^^^^^
Each layer provides its compilation environment. It is usefull if you want to compile
just this specific layer (it will upload and install all dependancies of the layer including
other dtk layers).
In order to compile, the easiest way is to install the conda dtk-core environment
For example, to compile dtkCore:
* install conda
* get dtkCore sources (https://gitlab.inria.fr/dtk/dtk-core)
* create a new environment
.. code-block:: bash
......@@ -41,3 +49,9 @@ In order to compile, the easiest way is to install the conda dtk-core environmen
That's all folks !
Compile all layers
^^^^^^^^^^^^^^^^^^
TODO
Quick installation
------------------
dtkCore is developped and validated on Linux (Debian/Fedora). It has been adapted to MacOS and Windows (Cygwin).
All dtk layers are developped for and validates on Linux disctirbutions (Debian/Fedora/centos..), to MacOS and Windows. It also compiles on IOS and Android platforms (see dtk-cross for more information).
Install
^^^^^^^
The easiest way to install dtkCore is to download it with conda.
Conda
^^^^^
All dtk-layers are also provided in dedicated **conda** channels:
* https://anaconda.org/dtk
* https://anaconda.org/dtk-forge
* https://anaconda.org/dtk-forge-staging
Each channel has a different policy of publishing (TODO)
Quick install
^^^^^^^^^^^^^
The easiest way to install a dtk layer is to declare a conda environment and install dtk packages inside this env.
* install conda. Follow the instuctions on: https://docs.conda.io/en/latest/miniconda.html
......@@ -18,8 +30,8 @@ The easiest way to install dtkCore is to download it with conda.
$ conda create --name dtk
$ conda activate dtk
* upload dtkCore layer
* upload a specific layer (dtkCore)
.. code-block:: bash
$ conda install -c dtk dtk-core
$ conda install -c dtk-forge dtk-core
......@@ -12,4 +12,17 @@ Examples
The following examples are provided:
* :doc:`Example 1: <./example/example1>` define a plugin factory
dtkLog
^^^^^^
*
dtkCore
^^^^^^^
* :doc:`Example 1: <./examples/core_001>` define a plugin factory
dtkWidgets
^^^^^^^^^^
*
......@@ -29,4 +29,4 @@ You can learn how to
* :doc:`Compile <./compile>` from sources
* :doc:`Examples <./examples>`
You also have access to the :doc:`API documentation <./documentation>`
You also have access to the :doc:`API documentation <./doxygen/index.html>` generated by Doxygen
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment