lang/solidity: conform README to doom conventions
This commit is contained in:
parent
6be1ee17e5
commit
9a730c0035
1 changed files with 26 additions and 10 deletions
|
@ -6,26 +6,42 @@ This module adds [[https://github.com/ethereum/solidity][Solidity]] support thro
|
||||||
+ Code completion (~[[https://github.com/ssmolkin1/company-solidity][company-solidity]]~)
|
+ Code completion (~[[https://github.com/ssmolkin1/company-solidity][company-solidity]]~)
|
||||||
+ Gas estimation (~C-c C-g~)
|
+ Gas estimation (~C-c C-g~)
|
||||||
|
|
||||||
* Install
|
* Table of Contents :TOC:
|
||||||
There are two options for linters.
|
- [[Module Flags][Module Flags]]
|
||||||
|
- [[Prerequisites][Prerequisites]]
|
||||||
|
- [[Solc][Solc]]
|
||||||
|
- [[Solium][Solium]]
|
||||||
|
- [[TODO][TODO]]
|
||||||
|
|
||||||
** [[https://github.com/ethereum/solc-js][Solc]]
|
* 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
|
#+BEGIN_SRC sh
|
||||||
npm install -g solc
|
npm install -g solc
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
** [[http://solium.readthedocs.io/en/latest/user-guide.html#installation][Solium]]
|
** Solium
|
||||||
#+BEGIN_SRC sh
|
#+BEGIN_SRC sh
|
||||||
npm install -g solium
|
npm install -g solium
|
||||||
#+END_SRC
|
#+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
|
#+BEGIN_SRC emacs-lisp
|
||||||
(setq flycheck-solidity-solium-soliumrcfile "/$HOME/.soliumrc.json")
|
(setq flycheck-solidity-solium-soliumrcfile "~/.soliumrc.json")
|
||||||
#+END_SRC
|
#+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
|
* TODO
|
||||||
+ Snippets
|
+ Snippets
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue