diff --git a/doc/_static/logo_github.png b/doc/_static/logo_github.png new file mode 100644 index 00000000..e03d8dd8 Binary files /dev/null and b/doc/_static/logo_github.png differ diff --git a/doc/_templates/sideb.html b/doc/_templates/sideb.html index 7df7dffd..9e3966a5 100644 --- a/doc/_templates/sideb.html +++ b/doc/_templates/sideb.html @@ -10,5 +10,5 @@


- Visit the project on GitHub + Visit the project on GitHub

diff --git a/doc/index.rst b/doc/index.rst index 97e25432..4119935f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,12 +3,12 @@ app4triqs ========= -.. sidebar:: app4triqs 2.2 +.. sidebar:: app4triqs 2.2.0 - This is the homepage app4triqs Version 2.2 - For changes see, Cf :ref:`changelog page ` + This is the homepage of app4triqs v2.2.0. + For changes see the :ref:`changelog page `. -An example application using cpp2py and triqs. +An example application using cpp2py and TRIQS. This documentation is generated based on `rst `_ files and the comments in the sources and headers. diff --git a/doc/install.rst b/doc/install.rst index 288e9328..1b0ed56e 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -2,15 +2,15 @@ .. _install: -Compiling AP4TRIQS from source -============================== +Compiling app4triqs from source +=================================== -Prerequisite -------------------- +Prerequisites +------------- #. The :ref:`TRIQS ` library, see :ref:`TRIQS installation instruction `. - In the following, we assume that Triqs is installed in the ``path_to_triqs`` directory. + In the following, we assume that TRIQS is installed in the directory ``path_to_triqs``. Installation steps ------------------ @@ -40,12 +40,10 @@ Installation steps Version compatibility --------------------- -Be careful that the version of the TRIQS library and of the application must be -compatible (more information on the :ref:`TRIQS website `). -In particular you should make sure that the Major and Minor Version number -of the application and TRIQS agree. -If you want to use a particular version of the application, go into the directory with the sources -and look at all available versions:: +Keep in mind that the version of ``app4triqs`` must be compatible with your TRIQS library version, +see :ref:`TRIQS website `. +In particular the Major and Minor Version numbers have to be the same. +To use a particular version, go into the directory with the sources, and look at all available versions:: $ cd app4triqs.src && git tag @@ -53,12 +51,12 @@ Checkout the version of the code that you want:: $ git checkout 2.1.0 -Then follow the steps 2 to 4 described above to compile the code. +and follow steps 2 to 4 above to compile the code. Custom CMake options -------------------- -Functionality of ``app4triqs`` can be tweaked using extra compile-time options passed to CMake:: +The compilation of ``app4triqs`` can be configured using CMake-options:: cmake ../app4triqs.src -DOPTION1=value1 -DOPTION2=value2 ... ../app4triqs.src