Skip to content

Commit 458763d

Browse files
committed
Mention solium integration in the readme
1 parent 1b4f5f9 commit 458763d

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.org

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,43 @@ Regardless of where you installed solidity mode from, you need to require the pa
3030
#+END_SRC
3131
(append that line to your =~/.emacs= file)
3232

33-
** Provide path to solc binary
34-
The ~solc~ binary is assumed to be located at ~/usr/bin/solc~. Wherever that is not the case you would have to manually
33+
** Interface with linters
34+
*** Provide path to solc binary
35+
The ~solc~ binary is assumed to be part of the PATH. Wherever that is not the case you would have to manually
3536
set the location of the binary like below:
3637
#+BEGIN_SRC emacs-lisp
3738
(setq solidity-solc-path "/home/lefteris/ew/cpp-ethereum/build/solc/solc")
3839
#+END_SRC
3940

4041
Note: This better be set before requiring solidity mode.
4142

43+
*** Provide path to solium binary
44+
The ~solium~ binary is assumed to be part of the user's ~PATH~. If this is not the case
45+
then set its location like below:
46+
#+BEGIN_SRC emacs-lisp
47+
(setq solidity-solium-path "/home/lefteris/.npm-global/bin/solium")
48+
#+END_SRC
49+
50+
4251
** [Optional] Flycheck interface
4352
Solidity mode can also interface with [[https://github.com/flycheck/flycheck][flycheck]] if you have it. Make sure to
4453
download and install the flycheck package. Then configure it to either work on
4554
all modes or enable it only for solidity mode.
4655

56+
Flycheck can interface either with solc or with [[http://solium.readthedocs.io/en/latest/][solium]]. Choose the appropriate
57+
linter to use by providing the following in your emacs init:
58+
59+
#+BEGIN_SRC emacs-lisp
60+
(setq solidity-flycheck-active-checker "solium")
61+
#+END_SRC
62+
63+
If you want to use ~"solc"~ replace ~"solium"~ with it.
64+
65+
Keep in mind that you need to provide the path to either solc or solium unless
66+
emacs can already find it in your environment's ~PATH~. Even if you can call it
67+
from the command line it does not mean that EMACS can see it as emacs may be started
68+
by systemd at which point ~PATH~ is not fully populated.
69+
4770
* Features
4871
+ Syntax highlighting
4972
+ Indentation

0 commit comments

Comments
 (0)