mirror of https://gitlab.com/basile.b/dexed.git
doc
This commit is contained in:
Basile Burg
parent
b13e3732ea
commit
6c1bf16afe
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
|
|
@ -49,6 +49,7 @@ _Full description of Coedit options. May redirect to a specific widget page._
|
|||
|
||||
_Description of each widget._
|
||||
|
||||
* [About box](widgets_about)
|
||||
* [DFMT commander](widgets_dfmt_commander)
|
||||
* [DUB project editor](widgets_dub_project_editor)
|
||||
* [CE project editor](widgets_ce_project_editor)
|
||||
|
|
|
|||
|
|
@ -1,3 +1,60 @@
|
|||
---
|
||||
title: Setup Coedit
|
||||
---
|
||||
|
||||
There are four ways to get the program:
|
||||
* download and run the setup program build for each release.
|
||||
* download and extract the binaries build for each release.
|
||||
* [build](build) the program from the sources.
|
||||
* download and install the official package for a linux distribution.
|
||||
|
||||
In all the cases, the _DMD_ D2 compiler must setup and its location has to match to one of the directory of the PATH environment variable.
|
||||
If it's not already installed, [download](http://dlang.org/download.html) and setup DMD2 for your platform.
|
||||
The latest Coedit version requires at least DMD 2.072.
|
||||
|
||||
For each platform Coedit can be setup from using a setup program or by extracting the binaries.
|
||||
|
||||
### Setup program
|
||||
|
||||
* Go to [the release page](https://github.com/BBasile/Coedit/releases),
|
||||
* Choose the zipped setup for your platform (at the bottom of a release log, the buttons labeled `coedit.<version>.<platform>.setup.zip`).
|
||||
* The content must be extracted and executed:
|
||||
* note that the option `--nodcd` can be typed to skip the installation of the completion daemon.
|
||||
* Linux, setup for all the users: in a console `cd` to the file location and type `sudo ./coedit.<version>.<platform>.setup`.
|
||||
* Linux, setup for the current user: in a console `cd` to the file location and type: `./coedit.<version>.<platform>.setup`.
|
||||
* Windows, optional, it may be necessary to deactivate your anti-virus software. Norton AV or McAfee hav been reported for detecting a potential threat.
|
||||
* Windows: double click, and confirm in the UAC dialog box.
|
||||
* To uninstall, run the same program but with the `-u` option.
|
||||
* Linux: if coedit has been setup with `sudo` you must also uninstall with elevated privileges: `sudo ./coedit.<version>.<platform>.setup -u`.
|
||||
* Windows: start a console as administrator and execute: `coedit.<version>.win32.setup -u`.
|
||||
* Troubleshooting: run the setup program with the `-l` (or `--list`) option to get the status of the files and use the report to uninstall manually the files or open a ticket [here][lnk_bugtracker].
|
||||
|
||||
Note for the future versions:
|
||||
* Updating doesn't require to uninstall.
|
||||
* it's possible to uninstall from a newer setup program.
|
||||
* always use the same privileges to uninstall or update as used previously.
|
||||
|
||||
### Binaries
|
||||
|
||||
* Go to [the release page](https://github.com/BBasile/Coedit/releases),
|
||||
* Choose the binaries for your platform (at the bottom of an entry, the buttons labeled `coedit.<version>.<platform>.zip`).
|
||||
* Extract the executables.
|
||||
* Linux: it's recommended to put them in `/home/<your account>/bin`, since it's a known system PATH and that it doesn't require the super user privileges.
|
||||
* Windows: the target folder must be added to your system PATH variable. When the location is not known the background tools won't work (symbol list, todo list, DCD).
|
||||
|
||||
Under Windows, the releases are compressed with the latest [7-zip beta](http://www.7-zip.org/) with the options _deflate-ultra_. In case of problem try to use 7zip.
|
||||
Under Linux, the command line tool *zip* is used (_deflate_ and _-9_).
|
||||
|
||||
Under Linux you could have to set the files permission to allow their execution. This used to be necessary when
|
||||
the early alpha zip were all done on Windows (files attributes were lost) but it shouldn't be the case anymore.
|
||||
|
||||
If they are not correctly set, for each of the following file **coedit**, **dcd-client**, **dcd-server**, **dastworx**, either set the permission in the context menu (check _allow execution_ or _executable_ depending on the desktop) or `chmod a+x` the file in a console.
|
||||
|
||||
### Linux package
|
||||
|
||||
Only the _x86-64_ _rpm_ is available (Fedora, openSuse, ...). After the installation, you must also build [DCD](features_dcd).
|
||||
|
||||
### First steps
|
||||
|
||||
- verify the [compilers paths](widgets_compiler_paths).
|
||||
- check the information [about the tools](widgets_about).
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: About box
|
||||
---
|
||||
|
||||
{% include xstyle.css %}
|
||||
|
||||
The _about box_ displays the software version and the information about the tools used in background.
|
||||
|
||||
|
||||
|
||||
The status of each tool is indicated:
|
||||
|
||||
- <img src="{%include icurl%}bullet/bullet_green.png" class="tlbric"/>: The tool is well detected.
|
||||
- <img src="{%include icurl%}bullet/bullet_yellow.png" class="tlbric"/>: The tool cannot be found but it's not necessary. Expect some features not to work properly even if the software is still usable.
|
||||
- <img src="{%include icurl%}bullet/bullet_red.png" class="tlbric"/>: The tool cannot be found but it's necessary. The software is not usable. This happens when a the tool location is not indicated by a PATH entry.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -4,60 +4,6 @@ Welcome to the Coedit Wiki, the documentation source for the small Windows & Lin
|
|||
|
||||
 
|
||||
|
||||
# Detailed setup procedure
|
||||
|
||||
There are four ways to get the program, from the simplest to the most complex:
|
||||
* download and run the setup program build for each release.
|
||||
* download and extract the binaries build for each release.
|
||||
* build the program from the sources.
|
||||
* download and install the official package for a linux distribution.
|
||||
|
||||
In all the cases, the _DMD_ D2 compiler must setup and its location has to match to one of the directory of the PATH environment variable.
|
||||
If it's not already installed, [download](http://dlang.org/download.html) and setup DMD2 for your platform.
|
||||
The latest Coedit version requires at least DMD 2.066.
|
||||
|
||||
## Setup program
|
||||
|
||||
* Go to [the release page](https://github.com/BBasile/Coedit/releases),
|
||||
* Choose the zipped setup for your platform (at the bottom of a release log, the buttons labeled `coedit.<version>.<platform>.setup.zip`).
|
||||
* The content must be extracted and executed:
|
||||
* note that the option `--nodcd` can be typed to skip the installation of the completion daemon.
|
||||
* Linux, all users, in a console `cd` to the file location and type `sudo ./coedit.<version>.<platform>.setup`.
|
||||
* Linux, only you, in a console `cd` to the file location and type: `./coedit.<version>.<platform>.setup`.
|
||||
* Windows, optional, it may be necessary to deactivate your anti-virus software. Norton AV has been reported for detecting a potential threat in his heuristic module and Avast AV not to allow the setup at all.
|
||||
* Windows: double click, and confirm in the UAC dialog box.
|
||||
* To uninstall, run the same program but with the `-u` option.
|
||||
* Linux: if coedit has been setup with `sudo` you must also uninstall with elevated privileges: `sudo ./coedit.<version>.<platform>.setup -u`.
|
||||
* Windows: start a console as administrator and execute: `coedit.<version>.win32.setup -u`.
|
||||
* Troubleshooting: run the setup program with the `-l` (or `--list`) option to get the status of the files and use the report to uninstall manually the files or open a ticket [here][lnk_bugtracker].
|
||||
|
||||
Note for the future versions:
|
||||
* Updating doesn't require to uninstall.
|
||||
* it's possible to uninstall from a newer setup program.
|
||||
* always use the same privileges to uninstall or update as used previously.
|
||||
|
||||
## Binaries
|
||||
|
||||
* Go to [the release page](https://github.com/BBasile/Coedit/releases),
|
||||
* Choose the binaries for your platform (at the bottom of an entry, the buttons labeled `coedit.<version>.<platform>.zip`).
|
||||
* Extract the executables.
|
||||
* Linux: it's recommended to put them in `/home/<your account>/bin`, since it's a known system PATH and that it doesn't require the super user privileges.
|
||||
* Windows: the target folder must be added to your system PATH variable. When the location is not known the background tools won't work (symbol list, todo list, DCD).
|
||||
|
||||
Under Windows, the releases are compressed with the latest [7-zip beta](http://www.7-zip.org/) with the options _deflate-ultra_. In case of problem try to use 7zip.
|
||||
Under Linux, the command line tool *zip* is used (_deflate_ and _-9_).
|
||||
|
||||
Under Linux you could have to set the files permission to allow their execution. This used to be necessary when
|
||||
the early alpha zip were all done on Windows (files attributes were lost) but it shouldn't be the case anymore.
|
||||
|
||||
If they are not correctly set, for each of the following file **coedit**, **dcd-client**, **dcd-server**, **cetodo** and **cesyms**,
|
||||
either set the permission in the context menu (check _allow execution_ or _executable_ depending on the desktop)
|
||||
or `chmod a+x` the file in a console.
|
||||
|
||||
## Linux package
|
||||
|
||||
Only the _x86-64_ _rpm_ is available (Fedora, openSuse, ...). After the installation, you must also build [DCD][lnk_dcd].
|
||||
|
||||
# Menu reference
|
||||
|
||||
## File
|
||||
|
|
|
|||
Loading…
Reference in New Issue