From d2d690ec93857f686b611c3dcc99f2271764cd39 Mon Sep 17 00:00:00 2001 From: Reed Mullanix Date: Wed, 22 May 2019 21:58:05 -0700 Subject: [PATCH] Add docs --- modules/lang/fsharp/README.org | 54 ++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 modules/lang/fsharp/README.org diff --git a/modules/lang/fsharp/README.org b/modules/lang/fsharp/README.org new file mode 100644 index 000000000..b4d2874ec --- /dev/null +++ b/modules/lang/fsharp/README.org @@ -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.