docs(coq): expand README
+ Hack: Abbrevs are replaced with snippets + Installation: To enable completion you also need :completion company + Installation: coqtop is required, link to coq download site + Troubleshooting: Link to related github issues
This commit is contained in:
parent
7423eef243
commit
c9399c1a19
1 changed files with 10 additions and 12 deletions
|
@ -22,30 +22,28 @@ This module adds [[https://coq.inria.fr][coq]] support, powered by [[https://pro
|
||||||
- [[doom-package:][company-coq]]
|
- [[doom-package:][company-coq]]
|
||||||
|
|
||||||
** Hacks
|
** Hacks
|
||||||
/No hacks documented for this module./
|
+ Replaces coq-mode abbrevs with yasnippet snippets from doom's snippet library
|
||||||
|
|
||||||
** TODO Changelog
|
** TODO Changelog
|
||||||
# This section will be machine generated. Don't edit it by hand.
|
# This section will be machine generated. Don't edit it by hand.
|
||||||
/This module does not have a changelog yet./
|
/This module does not have a changelog yet./
|
||||||
|
|
||||||
* TODO Installation
|
* Installation
|
||||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
+ [[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||||
|
+ To use the completion features of company-coq you need to enable ~(:completion company)~
|
||||||
#+begin_quote
|
+ Make sure you have Coq installed and that the ~coqtop~ command is available. This comes with a standard installation of Coq.
|
||||||
🔨 /This module's prerequisites are not documented./ [[doom-contrib-module:][Document them?]]
|
You can use your linux distribution's Coq package or one of the methods given on the [[https://coq.inria.fr/download][Coq website]].
|
||||||
#+end_quote
|
|
||||||
|
|
||||||
* TODO Usage
|
* TODO Usage
|
||||||
#+begin_quote
|
#+begin_quote
|
||||||
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
||||||
#+end_quote
|
#+end_quote
|
||||||
|
|
||||||
* TODO Configuration
|
* Configuration
|
||||||
#+begin_quote
|
This module provides no additional configuration over that of the [[Packages]] it loads
|
||||||
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
|
||||||
#+end_quote
|
|
||||||
|
|
||||||
* Troubleshooting
|
* Troubleshooting
|
||||||
|
See [[https://github.com/hlissner/doom-emacs/issues?q=is%3Aissue+is%3Aopen+label%3A%22%3Alang+coq"][related github issues]]
|
||||||
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
||||||
|
|
||||||
* Frequently asked questions
|
* Frequently asked questions
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue