diff --git a/docs/modules.org b/docs/modules.org index 5ec4128e7..bd552174c 100644 --- a/docs/modules.org +++ b/docs/modules.org @@ -109,6 +109,7 @@ Modules that bring support for a language or group of languages to Emacs. + [[file:../modules/lang/ess/README.org][ess]] - TODO + [[file:../modules/lang/faust/README.org][faust]] - TODO + [[file:../modules/lang/fsharp/README.org][fsharp]] - TODO ++ [[file:../modules/lang/fstar/README.org][fstar]] - F* support + [[file:../modules/lang/go/README.org][go]] =+lsp= - TODO + [[file:../modules/lang/haskell/README.org][haskell]] =+dante +intero +lsp= - TODO + hy - TODO diff --git a/modules/lang/fstar/README.org b/modules/lang/fstar/README.org index 4f7c312b7..e40b253cc 100644 --- a/modules/lang/fstar/README.org +++ b/modules/lang/fstar/README.org @@ -1,3 +1,58 @@ -#+TITLE: :lang F* +#+TITLE: :lang fstar +#+TITLE: lang/fstar +#+DATE: February 2, 2020 +#+SINCE: 2.0.10 +#+STARTUP: inlineimages nofold + +* Table of Contents :TOC_3:noexport: +- [[#description][Description]] + - [[#maintainers][Maintainers]] + - [[#module-flags][Module Flags]] + - [[#plugins][Plugins]] +- [[#prerequisites][Prerequisites]] + - [[#f][F*]] + - [[#macos][macOS]] + - [[#arch-linux][Arch Linux]] +- [[#features][Features]] +- [[#configuration][Configuration]] +- [[#troubleshooting][Troubleshooting]] + +* Description This module adds [[https://fstar-lang.org/][F*]] support, powered by [[https://github.com/FStarLang/fstar-mode.el][fstar-mode.el]]. + ++ Syntax highlighting ++ Interactively process F* files one definition at a time ++ Query the running F* process to look up definitions, documentation, and + theorems + +** Maintainers ++ [[https://github.com/tchajed][@tchajed]] (Author) + +** Module Flags +This module provides no flags. + +** Plugins ++ [[https://github.com/FStarLang/fstar-mode.el][fstar-mode]] + +* Prerequisites +** F* +While fstar-mode supports the latest release of F*, you may have a better +experience installing a more recent version from source. See F*'s [[https://github.com/FStarLang/FStar/blob/master/INSTALL.md][INSTALL.md]]. +*** macOS +#+BEGIN_SRC sh +brew install fstar +#+END_SRC +*** Arch Linux +Install ~fstar~ from the AUR: +#+BEGIN_SRC sh +yaourt -S fstar +#+END_SRC + +* Features + +* Configuration + +* Troubleshooting +If you're having trouble getting F* to start correctly, you may need to +configure a few variables in fstar-mode; see its [[https://github.com/FStarLang/fstar-mode.el][README]] for more details. diff --git a/modules/lang/fstar/packages.el b/modules/lang/fstar/packages.el index 2916c38be..80c8aa533 100644 --- a/modules/lang/fstar/packages.el +++ b/modules/lang/fstar/packages.el @@ -1,4 +1,4 @@ ;; -*- no-byte-compile: t; -*- -;;; lang/fstar.el +;;; lang/fstar/packages.el (package! fstar-mode)