emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update READMEs & add new ones

Browse source
This commit is contained in:
Henrik Lissner 2017-05-25 20:08:50 +02:00
parent 9d1af37dee
commit e1f60b2bfd
13 changed files with 529 additions and 92 deletions
Download patch file Download diff file Expand all files Collapse all files

39
modules/completion/company/README.org Normal file
View file

@ -0,0 +1,39 @@
* :completion company
This module adds completion support powered by [[https://github.com/company-mode/company-mode][company]].
+ Uses ~company-quickhelp~ for documentation tooltips
+ Uses ~company-statistics~ to order results by usage frequency
[[/../screenshots/company.png]]
** Install
Specific languages may require additional setup. Some languages may have no completion support at all.
Check the README.org in that language's module for details.
** Customization
This module is configured to suit my preferences. Here are some things you may want to change:
*** as-you-type completion
By default, I've disabled auto-completion. This is my preference. I prefer to invoke company when I need it by pressing ~C-SPC~ from insert mode. Some don't like this.
To make it automatic, you need to do two things:
1. Load ~company~,
2. and change ~company-idle-delay~ to a non-nil float (the default is 0.5)
To do this, add the following to your ~modules/private/<username>~ module (remember, ~:private <username>~ needs to be added to init.el):
#+BEGIN_SRC emacs-lisp
(require 'company)
(setq company-idle-delay 0.2
company-minimum-prefix-length 3)
#+END_SRC
** Troubleshooting
If completion isn't working for you, please consider the following before posting a bug report:
+ Different languages will have different dependencies in order for auto-completion to work. Please look for the README.org in that language's respective module for details.
+ Some languages don't have any auto-completion support.
+ Check [[*Customization][Customization]], perhaps what you are expecting is popup-as-you-type completion, which is disabled by default.

21
modules/completion/ivy/README.org
View file

@ -1,28 +1,31 @@
* Ivy
* :completion ivy
Ivy is my completion backend of choice (over ido and helm), for its speed and
simplicity. With ivy's help and some hackery, I get the following features:
This module adds the Ivy completion backend.
+ Project-wide search & replace.
I prefer ivy over ido and helm, for its speed and simplicity. With ivy's help and some hackery, I get the following features:
+ Project-wide search & replace powered by ~rg~ (falls back to ~ag~)
+ Project jump-to navigation ala Command-T, Sublime Text's Jump-to-anywhere or Vim's CtrlP plugin.
+ Ivy integration for ~M-x~, ~imenu~, ~recentf~ and others.
+ A powerful, interactive in-buffer search using ~swiper~.
+ Ivy-powered TODO/FIXME navigation
** Dependencies
This module depends only on [[https://github.com/BurntSushi/ripgrep][ripgrep]].
** Install
This module optionally depends on [[https://github.com/BurntSushi/ripgrep][ripgrep]] and [[https://github.com/ggreer/the_silver_searcher][the_silver_searcher]].
~rg~ is faster, but its results aren't deterministic and it doesn't support multiline search or full PCRE, that's where ~ag~ is useful.
*** MacOS
#+BEGIN_SRC sh :tangle (if (doom-system-os 'macos) "yes")
brew install ripgrep
brew install ripgrep the_silver_searcher
#+END_SRC
*** Arch Linux
#+BEGIN_SRC sh :dir /sudo:: :tangle (if (doom-system-os 'arch) "yes")
sudo pacman --needed --noconfirm -S ripgrep
sudo pacman --needed --noconfirm -S ripgrep the_silver_searcher
#+END_SRC
** Highlights
** Usage
*** Search & Replace
A project-wide search can be performed with Ag (the silver searcher) or Rg
(ripgrep) via their ex commands: ~:ag[!]~ and ~:rg[!]~ (or their