From 9a730c00357103b54d3475239615be25b40680f4 Mon Sep 17 00:00:00 2001
From: Henrik Lissner <accounts@v0.io>
Date: Fri, 25 May 2018 19:10:49 +0200
Subject: [PATCH] lang/solidity: conform README to doom conventions

---
 modules/lang/solidity/README.org | 36 +++++++++++++++++++++++---------
 1 file changed, 26 insertions(+), 10 deletions(-)

diff --git a/modules/lang/solidity/README.org b/modules/lang/solidity/README.org
index b407c498f..69214de12 100644
--- a/modules/lang/solidity/README.org
+++ b/modules/lang/solidity/README.org
@@ -4,28 +4,44 @@ This module adds [[https://github.com/ethereum/solidity][Solidity]] support thro
 
 + Syntax-checking (~flycheck~)
 + Code completion (~[[https://github.com/ssmolkin1/company-solidity][company-solidity]]~)
-+ Gas estimation(~C-c C-g~)
-  
-* Install
-There are two options for linters.
++ Gas estimation (~C-c C-g~)
 
-** [[https://github.com/ethereum/solc-js][Solc]]
+* Table of Contents :TOC:
+- [[Module Flags][Module Flags]]
+- [[Prerequisites][Prerequisites]]
+  - [[Solc][Solc]]
+  - [[Solium][Solium]]
+- [[TODO][TODO]]
+
+* Module Flags
+This module provides no flags.
+
+* Prerequisites
+This module requires one or both linters for syntax checking:
+
++ [[https://github.com/ethereum/solc-js][Solc]]
++ [[http://solium.readthedocs.io/en/latest/user-guide.html#installation][Solium]]
+
+If both are enabled *Solc* is run first, then *Solium* if *Solc* catches no
+errors.
+
+** Solc
 #+BEGIN_SRC sh
 npm install -g solc
 #+END_SRC
 
-** [[http://solium.readthedocs.io/en/latest/user-guide.html#installation][Solium]]
+** Solium
 #+BEGIN_SRC sh
 npm install -g solium
 #+END_SRC
 
-By default *solium* looks for ~.soliumrc.json~ in the project directory, but you can set it to your own ~.soliumrc.json~ with this in your private doom ~config.el~
+By default *solium* looks for ~.soliumrc.json~ in the project directory, but you
+can set it to your own ~.soliumrc.json~ with this in your private doom
+~config.el~
 
 #+BEGIN_SRC emacs-lisp
-(setq flycheck-solidity-solium-soliumrcfile "/$HOME/.soliumrc.json")
+(setq flycheck-solidity-solium-soliumrcfile "~/.soliumrc.json")
 #+END_SRC
 
-They can be chained together so it's recommended you use both. *Solc* is ran first, and then *Solium* if *Solc* doesn't catch any errors.
-
 * TODO
 + Snippets