test documentation based on GH pages

This commit is contained in:
Basile Burg 2016-12-26 03:00:49 +01:00
parent 85eafc1d85
commit 562845107f
No known key found for this signature in database
GPG Key ID: 1868039F415CB8CF
3 changed files with 25 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 108 KiB

5
docs/index.md Normal file
View File

@ -0,0 +1,5 @@
### Coedit documentation
#### Options
* [Compiler paths](options_compilers_paths.html)

View File

@ -0,0 +1,20 @@
The _Compilers paths_ category is used to define the paths to the compilers and to their respective versions of the standard library.
These settings are important and should be verified after the installation.
![](img/compilers_paths.png)
Up to five D compilers can be defined.
* DMD: should be set to the stable DMD version. The paths are normally detected when _Coedit_ is launched for hte first time.
* GDC: should be set to the stable GDC version. The _runtime_ and _Phobos_ sources stand in the same folder so the third field can be left empty.
* LDC: should be set to the stable GDC version. The _runtime_ and _Phobos_ sources stand in the same folder so the third field can be left empty.
* User1: can be set to any compiler, for the example the development version of DMD.
* User2: same as _User1_.
The combo box at the top is used to select which are the paths passed to the completion daemon.
When the completion daemon is launched by _Coedit_ the change is applied directly after the validation, otherwise it has to be restarted manually.
In other categories of the options one of these compilers can be selected.
* Category _Application_, __nativeProjectCompiler_: defines the compiler used to compile a project that has the native format.
* Category _Runnable modules_, _compiler_: defines the compiler used to compile a _runnable module_ or a DUB script.
* Category _DUB build_, _compiler_: defines the compiler used to compile a project that has the DUB format.