7e400abdc0
Due to emacs-straight/org-mode@e22b4eb, a replacement major mode (for org-mode) can no longer be specified from .dir-locals.el, as it spirals into infinite recursion. Therefore, a mode: line is needed in all Doom docs. Ref: emacs-straight/org-mode@e22b4eb7aa
74 lines
2 KiB
Org Mode
74 lines
2 KiB
Org Mode
# -*- mode: doom-docs-org -*-
|
|
#+title: :lang fstar
|
|
#+subtitle: (Dependent) types and (monadic) effects and Z3
|
|
#+created: February 02, 2020
|
|
#+since: 21.12.0 (#2473)
|
|
|
|
* Description :unfold:
|
|
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
|
|
- [[doom-user:][@tchajed]]
|
|
|
|
[[doom-contrib-maintainer:][Become a maintainer?]]
|
|
|
|
** Module flags
|
|
/This module has no flags./
|
|
|
|
** Packages
|
|
- [[doom-package:][fstar-mode]]
|
|
|
|
** Hacks
|
|
/No hacks documented for this module./
|
|
|
|
** TODO Changelog
|
|
# This section will be machine generated. Don't edit it by hand.
|
|
/This module does not have a changelog yet./
|
|
|
|
* Installation
|
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
|
|
|
This module requires [[https://github.com/FStarLang/FStar/blob/master/INSTALL.md][F*]].
|
|
|
|
While ~fstar-mode~ supports the latest release of F*, you may have a better
|
|
experience installing a more recent version from source.
|
|
|
|
** macOS
|
|
#+begin_src sh
|
|
brew install fstar
|
|
#+end_src
|
|
|
|
** Arch Linux
|
|
~fstar~ is available in the AUR:
|
|
#+begin_src sh
|
|
yaourt -S fstar
|
|
#+end_src
|
|
|
|
* TODO Usage
|
|
#+begin_quote
|
|
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
|
#+end_quote
|
|
|
|
* TODO Configuration
|
|
#+begin_quote
|
|
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
|
#+end_quote
|
|
|
|
* Troubleshooting
|
|
[[doom-report:][Report an issue?]]
|
|
|
|
- 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.
|
|
|
|
* Frequently asked questions
|
|
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
|
|
|
* TODO Appendix
|
|
#+begin_quote
|
|
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
|
#+end_quote
|