LCPQ/dft_tools
3
0
Fork 0
mirror of https://github.com/triqs/dft_tools synced 2024-12-22 04:13:47 +01:00
Code Issues Releases Wiki Activity

[doc] Add missing changelog files, Update compile instructions

Browse Source
This commit is contained in:
Nils Wentzell 2018-06-04 16:40:50 -04:00
parent 2632f2c87f
commit 006702252c
3 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/ChangeLog.md Normal file
View File

@ -0,0 +1,5 @@
Version 1.5
-----------
* Added Debian Packaging
* Compatibility changes for TRIQS 2.0

8
doc/changelog.rst Normal file
View File

@ -0,0 +1,8 @@
.. _changelog:
Changelog
=========
This document describes the main changes in DftTools.
.. include:: ChangeLog.md

9
doc/install.rst
View File

@ -32,11 +32,12 @@ Installation steps
#. Create an empty build directory where you will compile the code:: #. Create an empty build directory where you will compile the code::
$ mkdir build && cd build $ mkdir dft_tools.build && cd dft_tools.build
#. In the build directory call cmake specifying where the TRIQS library is installed:: #. Make sure that you have added the TRIQS and Cpp2Py installation to your environment variables::
$ cmake -DTRIQS_PATH=path_to_triqs ../src $ source path_to_triqs/share/cpp2pyvarsh.sh
$ source path_to_triqs/share/triqsvarsh.sh
#. Compile the code, run the tests and install the application:: #. Compile the code, run the tests and install the application::
@ -114,7 +115,7 @@ Custom CMake options
Functionality of ``dft_tools`` can be tweaked using extra compile-time options passed to CMake:: Functionality of ``dft_tools`` can be tweaked using extra compile-time options passed to CMake::
cmake -DOPTION1=value1 -DOPTION2=value2 ... ../cthyb.src cmake -DOPTION1=value1 -DOPTION2=value2 ... ../dft_tools.src
+---------------------------------------------------------------+-----------------------------------------------+ +---------------------------------------------------------------+-----------------------------------------------+
| Options | Syntax | | Options | Syntax |