forks
/
dexed
mirror of https://gitlab.com/basile.b/dexed.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update building instructions

This commit is contained in:
Basile Burg 2020-04-17 16:41:48 +02:00
parent 13c5b5eceb
commit 26110d6df3
2 changed files with 27 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/build.md
View File

@ -5,36 +5,48 @@ header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4
Dexed is mostly programmed in Object Pascal, using the the [Lazarus development platform](http://www.lazarus-ide.org/). Dexed is mostly programmed in Object Pascal, using the the [Lazarus development platform](http://www.lazarus-ide.org/).
* [Download](http://lazarus.freepascal.org/index.php?page=downloads) and setup the latest Lazarus version (2.0.5) and FPC + FPC sources (3.0.4) for your platform. ## Pre-requisites
* Git
* [Download](http://lazarus.freepascal.org/index.php?page=downloads) and setup the latest Lazarus version (>= 2.0.6) and FPC + FPC sources (= 3.0.4) for your platform.
* Windows: the three packages are bundled in an installer. * Windows: the three packages are bundled in an installer.
* Linux: the three packages must be downloaded and setup individually. It's recommended to download the packages from _SourceForge_ and not from the official repository of the distribution because they don't always propose the latest version. * Linux: the three packages must be downloaded and setup individually. It's recommended to download the packages from _SourceForge_ and not from the official repository of the distribution because they don't always propose the latest version.
* [Download](https://github.com/ldc-developers/ldc/releases) and setup LDC2, the LLVM-based D compiler. It is used to compile the part of IDE written in D, a library called _libdexed-d_. the binaries must be visible in the system PATH variable. Note that building _libdexed-d_ is automatic. * [Download](https://github.com/ldc-developers/ldc/releases) and setup LDC2, the LLVM-based D compiler. It is used to compile the part of the IDE that's written in D, a library called _libdexed-d_. LDC2 binaries must be visible in the system PATH variable. Note that building _libdexed-d_ is automatic.
* `cd <user dir where to clone>`
* `git clone https://gitlab.com/basile.b/dexed.git`
* `git submodule update --init`, to clone the dependencies used by libdexed-d.
## Build
* `$ cd <user dir where to clone>`
* `$ git clone https://gitlab.com/basile.b/dexed.git`
* `$ git submodule update --init`, to clone the dependencies used by _libdexed-d_.
<!--
The Lazarus LCL and the FreePascal FCL may require patches that fix bugs or regressions present in the latest Lazarus release and for which Dexed cannot include workarounds. The Lazarus LCL and the FreePascal FCL may require patches that fix bugs or regressions present in the latest Lazarus release and for which Dexed cannot include workarounds.
Any `.patch` file located in the `patches/` folder should be applied. On linux you'll have to set the write permissions to `/usr/lib64/fpc` and `/usr/lib64/lazarus`. Any `.patch` file located in the `patches/` folder should be applied. On linux you'll have to set the write permissions to `/usr/lib64/fpc` and `/usr/lib64/lazarus`.
-->
You're now ready to build Dexed. This can be done in the IDE or using the _lazbuild_ utility. You're now ready to build Dexed. This can be done in the Lazarus IDE or using the _lazbuild_ utility.
* If you don't plan to develop the project, use _lazbuild_: * If you don't plan to develop the project, use _lazbuild_, note that its path may have to be specified:
* open a console. * open a console.
* `cd` to the repository location, sub folder **lazproj**. * `cd` to the repository location, sub folder **lazproj**.
* type `lazbuild -B dexeddesigncontrols.lpk` and <kbd>ENTER</kbd>. Note that the path to _lazbuild_ may have to be specified. * `$ lazbuild -B dexeddesigncontrols.lpk`.
* type `lazbuild -B dexed.lpi` and <kbd>ENTER</kbd>. Note that the path to _lazbuild_ may have to be specified. * `$ lazbuild -B dexed.lpi`.
* If you plan to help developing you'd better get started with _Lazarus_, which is less conveniant: * If you plan to help developing you'd better get started with _Lazarus_, although building is less conveniant:
* start Lazarus. * start Lazarus.
* setup `lazproj/cedsgncontrols.lpk` with Lazarus package manager (requires to rebuild Lazarus). * setup `lazproj/cedsgncontrols.lpk` with Lazarus package manager (requires to rebuild Lazarus).
* in the **project** menu, click *open...* and select the file **dexed.lpi**, which is located in the sub-folder **lazproj**. * in the **project** menu, click *open...* and select the file **dexed.lpi**, which is located in the sub-folder **lazproj**.
* in the menu **Execute** click **Create**. * in the menu **Execute** click **Create**.
After what Dexed should be build. The executable and the library are output to the _bin_ folder. After what _Dexed_ and _libdexed-d_ should be build, in the _bin_ folder.
The library might have to be copied to a specific path, e.g _/lib64/_ under linux. To use _dexed_, The library might have to be copied to a specific path, e.g _/lib64/_ under linux.
## Third party tools ## Third party tools
Additionally you'll have to build [the completion daemon **DCD**](https://github.com/dlang-community/DCD#setup) and the [D linter **Dscanner**](https://github.com/dlang-community/Dscanner#building-and-installing). Additionally you'll have to build
- the [completion daemon **DCD**](https://github.com/dlang-community/DCD#setup)
- the [D linter **Dscanner**](https://github.com/dlang-community/Dscanner#building-and-installing).
See the products documentation for more information. See the products documentation for more information.
<script>anchors.add();</script> <script>anchors.add();</script>

4
docs/index.md
View File

@ -5,14 +5,14 @@ header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4
![](img/coedit_kde4_thumb.png) ![](img/coedit_kde4_thumb.png)
This documentation is based on Dexed version 3.8.2. This documentation is based on Dexed version 3.8.9-dev.
Screenshots can be outdated but descriptions are up to date. Screenshots can be outdated but descriptions are up to date.
## First steps ## First steps
_Install and configure Dexed._ _Install and configure Dexed._
* [Build](build.html) * [Build](build.html), warning: not relevant for dexed 3.8.0 to 3.8.4. See this [old instructions instead](https://gitlab.com/basile.b/dexed/-/blob/v3.8.4/docs/build.md).
* [Setup](setup.html) * [Setup](setup.html)
## Features ## Features