forks
/
DCD
mirror of https://github.com/dlang-community/DCD.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README

This commit is contained in:
Hackerpilot 2014-07-10 14:55:37 -07:00
parent f17b25e1dc
commit c04700b41d
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -3,12 +3,14 @@ The D Completion Daemon is an auto-complete program for the D programming langua
![Teaser](teaser.png "This is what the future looks like - Jayce, League of Legends") ![Teaser](teaser.png "This is what the future looks like - Jayce, League of Legends")
(The above is a screenshot of [Textadept](http://foicica.com/textadept/))
DCD consists of a client and a server. The client (dcd-client) is used by a text editor script or from the command line. DCD consists of a client and a server. The client (dcd-client) is used by a text editor script or from the command line.
The server (dcd-server) is responsible for caching imported files, calculating autocomplete information, and sending it The server (dcd-server) is responsible for caching imported files, calculating autocomplete information, and sending it
back to the client. back to the client.
#Status #Status
*This program is still in an alpha state.* *This program is reasonably stable.*
* Working: * Working:
* Autocompletion of properties of built-in types such as int, float, double, etc. * Autocompletion of properties of built-in types such as int, float, double, etc.
@ -21,17 +23,17 @@ back to the client.
* Finding the declaration location of a symbol at the cursor * Finding the declaration location of a symbol at the cursor
* *import* statement completions * *import* statement completions
* Display of documentation comments in function call tips * Display of documentation comments in function call tips
* *alias this*
* Not working: * Not working:
* Automatic starting of the server by the client * Automatic starting of the server by the client
* UFCS * UFCS
* Autocompletion of declarations with template arguments * Autocompletion of declarations with template arguments
* *auto* declarations * *auto* declarations
* *alias this*
* Determining the type of an enum member when no base type is specified, but the first member has an initialaizer * Determining the type of an enum member when no base type is specified, but the first member has an initialaizer
* That one feature that you *REALLY* needed * That one feature that you *REALLY* needed
#Setup #Setup
1. Install a recent D compiler. DCD is only tested with DMD 2.064.2 1. Install a recent D compiler. DCD is tested with 2.065 and the 2.066 betas.
1. Run ```git submodule update --init``` after cloning this repository to grab the MessagePack and Datapacked libraries and the parser from DScanner. 1. Run ```git submodule update --init``` after cloning this repository to grab the MessagePack and Datapacked libraries and the parser from DScanner.
1. run the ```build.sh``` script to build the client and server. (Or build.bat on Windows) 1. run the ```build.sh``` script to build the client and server. (Or build.bat on Windows)
1. Configure your text editor to call the dcd-client program. See the *editors* folder for directions on configuring your specific editor. 1. Configure your text editor to call the dcd-client program. See the *editors* folder for directions on configuring your specific editor.