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

update doc

This commit is contained in:
Basile Burg 2020-04-17 13:58:02 +02:00
parent 50f103ae17
commit a41bb22e48
3 changed files with 11 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/build.md
View File

@ -3,16 +3,15 @@ title: Build Dexed
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script> header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
--- ---
## Dexed
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.0) and FPC + FPC sources (3.0.4) for your platform. * [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.
* 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.
* `cd <user dir where to clone>` * `cd <user dir where to clone>`
* `git clone https://github.com/Basile-z/dexed.git` * `git clone https://gitlab.com/basile.b/dexed.git`
* `git submodule update --init`, to clone the dependencies used by the background tool. * `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`.
@ -31,19 +30,8 @@ You're now ready to build Dexed. This can be done in the IDE or using the _lazbu
* 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 is output to the _bin_ folder. After what Dexed should be build. The executable and the library are output to the _bin_ folder.
The library might have to be copied to a specific path, e.g _/lib64/_ under linux.
## Dastworx
The background tool used by the IDE is a D program.
* [Download](https://dlang.org/download.html#dmd) and setup latest DMD version. Other D compiler are also supported. For example to compile with LDC, set the encironment variable DC: `DC=ldc2`.
* In the repository, browse to the `dastworx` folder.
* Windows: double click `build.bat`
* Linux: `bash ./build.sh`
You can also build it in dexed using the project file _dastworx.dprj_.
## 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) and the [D linter **Dscanner**](https://github.com/dlang-community/Dscanner#building-and-installing).

1
docs/widgets_symbol_list.md
View File

@ -4,7 +4,6 @@ header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4
--- ---
This list displays the symbols declared in the D module that has the focus (imports, classes, variables, etc). This list displays the symbols declared in the D module that has the focus (imports, classes, variables, etc).
The widget is a GUI front-end for one the [_dastworx_](https://gitlab.com/basile.b/dexed/-/tree/master/dastworx) feature.
It can be used to quickly find and go to the declaration of a symbol but also as a basic linter since the syntactic errors are displayed (almost immediately if the option _refresh on change_ is checked). It can be used to quickly find and go to the declaration of a symbol but also as a basic linter since the syntactic errors are displayed (almost immediately if the option _refresh on change_ is checked).

8
setup/readme.md
View File

@ -5,12 +5,14 @@ This folder contains the files necessary to manually build dexed and its toolcha
### Building ### Building
- git - git
- Freepascal 3.0.4
- Lazarus 2.0.8
- ldc2 - ldc2
### Releaseing ### Releasing
Same tools as to build plus:
- git
- ldc2
- rpm - rpm
- dpkg - dpkg
- zip - zip