diff --git a/editors/emacs/README.md b/editors/emacs/README.md index d7c2742..44df6d9 100644 --- a/editors/emacs/README.md +++ b/editors/emacs/README.md @@ -1,13 +1,14 @@ -#EMACS Integration +#Emacs Integration ##Requirements -* You must have the [auto-complete](https://github.com/auto-complete/auto-complete) package. +* You must have the [auto-complete](https://github.com/auto-complete/auto-complete) package, and [yasnippet](https://github.com/capitaomorte/yasnippet) package is recommended. * Make sure dcd-client and dcd-server is in your exec-path. Otherwise, please set the variable ```dcd-exectutable``` and ```dcd-server-executable``` using ```M-x customize```. ## Setup * First, follow the Setup section in the root README. * Second, add the following to your .emacs. With this setting, dcd-server starts automatically when you open file in d-mode. ``` +;;; ac-dcd (add-to-list 'load-path "path_to_ac-dcd.el") (require 'ac-dcd) (add-to-list 'ac-modes 'd-mode) @@ -16,13 +17,15 @@ (add-to-list 'ac-sources 'ac-source-dcd) (auto-complete-mode t)) (add-hook 'd-mode-hook 'ac-d-mode-setup) + +(define-key d-mode-map (kbd "C-c C-h") 'ac-dcd-popup-ddoc-at-point) ;of course, you can change this keybind. + ``` + * Third, set import path using ```M-x customize-variable RET ac-dcd-flags```. * When something is wrong, please check variables with ```M-x customize-apropos RET ac-dcd``` and restart server with ```M-x ac-dcd-init-server```. ## TODO -* better error detection -* detailed ac-source symbol * goto definition -* show doc +* Multi byte character support (Need help!) * and so on...