lang/nim: revise & conform readme to conventions #568

modules/lang/nim/README.org

@@ -6,24 +6,33 @@ This module is a work in progress.
 
 This module adds [[https://nim-lang.org][Nim]] support to Emacs.
 
-+ Code completion (~nimsuggest+company~)
++ Code completion (nimsuggest + company)
-+ Syntax checking (~nimsugges+flycheck~)
++ Syntax checking (nimsuggest + flycheck)
 + Babel support (~ob-nim~)
-#+begin_quote
-...
-#+end_quote
 
 * Table of Contents :TOC:
-- [[Install][Install]]
+- [[Module Flags][Module Flags]]
+- [[Prerequisites][Prerequisites]]
   - [[Nim][Nim]]
+- [[Configuration][Configuration]]
+
+* Module Flags
+This module provides no flags.
+
+* Prerequisites
++ ~nim~ (for building & evaluation)
++ ~nimsuggest~ (for code completion, syntax checking & jump-to-definition functionality)
 
-* Install
 ** Nim
-To get started with Nim, you can either use =choosenim= and install nim with:
+=choosenim= is an installer and version manager for the Nim programming
+language. You can install the latest stable release of Nim by running the
+following in your terminal and following the onscreen instructions:
 
-~curl https://nim-lang.org/choosenim/init.sh -sSf | sh~
+#+BEGIN_SRC bash
+curl https://nim-lang.org/choosenim/init.sh -sSf | sh
+#+END_SRC
 
-Or through your package manager:
+Alternatively, nim is usually available through your OS's package manager:
 
 *** MacOS
 #+BEGIN_SRC sh :tangle (if (doom-system-os 'macos) "yes")
@@ -32,6 +41,7 @@ brew install nim
 
 *** Arch Linux
 #+BEGIN_SRC sh :dir /sudo:: :tangle (if (doom-system-os 'arch) "yes")
-sudo pacman --needed --noconfirm -S nim
+sudo pacman --needed --noconfirm -S nim nimble
 #+END_SRC
 
+* Configuration