Add docs
This commit is contained in:
parent
94cf5a1129
commit
d2d690ec93
1 changed files with 54 additions and 0 deletions
54
modules/lang/fsharp/README.org
Normal file
54
modules/lang/fsharp/README.org
Normal file
|
@ -0,0 +1,54 @@
|
||||||
|
#+TITLE: lang/fsharp
|
||||||
|
#+DATE: May 22, 2019
|
||||||
|
#+SINCE: {replace with next tagged release version}
|
||||||
|
#+STARTUP: inlineimages
|
||||||
|
|
||||||
|
* Table of Contents :TOC_3:noexport:
|
||||||
|
- [[#description][Description]]
|
||||||
|
- [[#module-flags][Module Flags]]
|
||||||
|
- [[#plugins][Plugins]]
|
||||||
|
- [[#hacks][Hacks]]
|
||||||
|
- [[#prerequisites][Prerequisites]]
|
||||||
|
- [[#mono][Mono]]
|
||||||
|
- [[#osx][OSX]]
|
||||||
|
- [[#arch-linux][Arch Linux]]
|
||||||
|
- [[#features][Features]]
|
||||||
|
- [[#configuration][Configuration]]
|
||||||
|
- [[#troubleshooting][Troubleshooting]]
|
||||||
|
|
||||||
|
* Description
|
||||||
|
# A summary of what this module does.
|
||||||
|
|
||||||
|
# + If possible, include a brief list of feature highlights here
|
||||||
|
# + Like code completion, syntax checking or available snippets
|
||||||
|
# + Include links to packages & external things where possible
|
||||||
|
This module adds [[https://fsharp.org/][F#]] support.
|
||||||
|
+ Code completion
|
||||||
|
+ eldoc support
|
||||||
|
+ Syntax checking
|
||||||
|
|
||||||
|
** Module Flags
|
||||||
|
This module provides no flags.
|
||||||
|
|
||||||
|
** Plugins
|
||||||
|
+ [[https://github.com/fsharp/emacs-fsharp-mod+e][fsharp-mode]]
|
||||||
|
** Hacks
|
||||||
|
None so far.
|
||||||
|
|
||||||
|
* Prerequisites
|
||||||
|
** Mono
|
||||||
|
To get code completion/syntax checking, you will need to install [[https://www.mono-project.com/][mono]].
|
||||||
|
*** OSX
|
||||||
|
Do *NOT* install mono via brew. See this [[https://github.com/fsharp/FsAutoComplete/issues/331][issue]].
|
||||||
|
*** Arch Linux
|
||||||
|
#+BEGIN_SRC sh
|
||||||
|
sudo pacman -S mono
|
||||||
|
#+END_SRC
|
||||||
|
* Features
|
||||||
|
An in-depth list of features, how to use them, and their dependencies.
|
||||||
|
|
||||||
|
* Configuration
|
||||||
|
How to configure this module, including common problems and how to address them.
|
||||||
|
|
||||||
|
* Troubleshooting
|
||||||
|
Common issues and their solution, or places to look for help.
|
Loading…
Add table
Add a link
Reference in a new issue