Update readme

This commit is contained in:
Hackerpilot 2016-01-14 00:04:33 -08:00
parent 8a70d4c10a
commit af9233d2ea
1 changed files with 13 additions and 3 deletions

View File

@ -41,14 +41,24 @@ the issue.)
* That one feature that you *REALLY* needed
# Setup
### General
1. Install a recent D compiler. DCD is tested with DMD 2.068.2, DMD 2.069.0-rc2, and LDC 0.16 (Do not use DMD 2.068.1)
1. Run ```git submodule update --init --recursive``` after cloning this repository to grab the various dependencies.
1. Run ```make``` to build the client and server. (Or run build.bat on Windows). ```make ldc``` and ```make gdc``` will use the LDC or GDC compilers. The resulting executable will be much faster.
1. Follow the directions listed below for Homebrew, Git + Make, or Dub, depending on how you would like to build DCD.
1. Configure your text editor to call the dcd-client program. See the [wiki](https://github.com/Hackerpilot/DCD/wiki/IDEs-and-Editors-with-DCD-support) for information on configuring your specific editor.
1. Start the dcd-server program before editing code. (Unless, of course, your editor's plugin handles this for you)
### Git + Make
1. Install a recent D compiler. DCD is tested with DMD 2.068.2, DMD 2.069.0-rc2, and LDC 0.16 (Do not use DMD 2.068.1)
1. Run ```git submodule update --init --recursive``` after cloning this repository to grab the various dependencies.
1. Run ```make``` to build the client and server. (Or run build.bat on Windows). ```make ldc``` and ```make gdc``` will use the LDC or GDC compilers. The resulting executable will be much faster.
### OS X w/ Homebrew
```brew install dcd``` followed by points 4 & 5 above.
1. ```brew install dcd```
### Dub
1. ```dub build --build=release --config=client```
1. ```dub build --build=release --config=server```
# Client
Because DCD is designed to be used from a text editor, this section is written