docs(:lang): update READMEs to new format
This commit is contained in:
parent
ca7579a1e9
commit
20cac97c08
61 changed files with 4261 additions and 2634 deletions
|
@ -1,46 +1,71 @@
|
|||
#+TITLE: lang/faust
|
||||
#+DATE: July 23, 2019
|
||||
#+SINCE: v2.1.0
|
||||
#+STARTUP: inlineimages
|
||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::lang faust][Issues]] ↖ [[doom-module-source:lang/faust][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
--------------------------------------------------------------------------------
|
||||
#+TITLE: :lang faust
|
||||
#+SUBTITLE: DSP, but you can keep your soul
|
||||
#+CREATED: October 14, 2019
|
||||
#+SINCE: 21.12.0 (#1898)
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#features][Features]]
|
||||
* Description :unfold:
|
||||
Add support to [[https://faust.grame.fr/][Faust language]] inside emacs.
|
||||
|
||||
* Description
|
||||
Add support to Faust language inside emacs.
|
||||
- Faust code syntax highlighting and indentation
|
||||
- Project-based (inter-linked Faust files)
|
||||
- Build/compile with output window
|
||||
- Graphic diagrams generation and visualization in the (default) browser
|
||||
- Browse generated C++ code inside Emacs
|
||||
- Inter-linked files/buffers :
|
||||
- From "component" to Faust file
|
||||
- From "include" to Faust library file
|
||||
- From error to file:line number
|
||||
- From function name to online documentation
|
||||
- Fully configurable (build type/target/architecture/toolkit, keyboard
|
||||
shortcuts, etc.)
|
||||
- Automatic keyword completion (if Auto-Complete is installed)
|
||||
- Automatic objets (functions, operators, etc.) template insertion with default
|
||||
sensible values (if [[doom-module:][:editor snippets]] is enabled)
|
||||
- Modeline indicator of the state of the code
|
||||
|
||||
+ Faust code syntax hightlighting and indentation
|
||||
+ Project-based (inter-linked Faust files)
|
||||
+ Build/compile with output window
|
||||
+ Graphic diagrams generation and vizualisation in the (default) browser
|
||||
+ Browse generated C++ code inside Emacs
|
||||
+ Inter-linked files/buffers :
|
||||
+ From "component" to Faust file
|
||||
+ From "include" to Faust library file
|
||||
+ From error to file:line number
|
||||
+ From function name to online documentation
|
||||
+ Fully configurable (build type/target/architecture/toolkit, keyboard shortcuts, etc.)
|
||||
+ Automatic keyword completion (if Auto-Complete is installed)
|
||||
+ Automatic objets (functions, operators, etc.) template insertion with default sensible values (if Yasnippet is installed)
|
||||
+ Modeline indicator of the state of the code
|
||||
** Maintainers
|
||||
*This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Plugins
|
||||
+ [[https://bitbucket.org/yphil/faustine][faustine]]
|
||||
** Packages
|
||||
- [[doom-package:][faustine]]
|
||||
|
||||
* Features
|
||||
Keybindings
|
||||
** Hacks
|
||||
- Both ~faust-mode~ and ~faustine-mode~ are hardcoded to use [[doom-package:][auto-complete]],
|
||||
which Doom does not use. Its obnoxious 'You really should install and use
|
||||
auto-complete' warnings have been silenced.
|
||||
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
| Binding | Description |
|
||||
|-------------------+----------------------|
|
||||
| ~<localleader> b~ | ~build~ |
|
||||
| ~<localleader> c~ | ~syntax check~ |
|
||||
| ~<localleader> d~ | ~diagram~ |
|
||||
| ~<localleader> h~ | ~online dock~ |
|
||||
| ~<localleader> RET~ | ~mdoc~ |
|
||||
| ~<localleader> o~ | ~toggle output buffer~ |
|
||||
| ~<localleader> s~ | ~source code~ |
|
||||
| ~<localleader> r~ | ~run~ |
|
||||
| ~<localleader> S-b~ | ~build all~ |
|
||||
| ~<localleader> S-d~ | ~diagram all~ |
|
||||
| [[kbd:][<localleader> b]] | build |
|
||||
| [[kbd:][<localleader> c]] | syntax check |
|
||||
| [[kbd:][<localleader> d]] | diagram |
|
||||
| [[kbd:][<localleader> h]] | online dock |
|
||||
| [[kbd:][<localleader> RET]] | mdoc |
|
||||
| [[kbd:][<localleader> o]] | toggle output buffer |
|
||||
| [[kbd:][<localleader> s]] | source code |
|
||||
| [[kbd:][<localleader> r]] | run |
|
||||
| [[kbd:][<localleader> S-b]] | build all |
|
||||
| [[kbd:][<localleader> S-d]] | diagram all |
|
||||
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* Troubleshooting
|
||||
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
||||
|
||||
* 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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue