Skip to content

Commit adaae56

Browse files
committed
Add gas estimation info in README
1 parent c5039e4 commit adaae56

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.org

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,14 @@ 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+
** Keymap
34+
You can modify the default keybindings of the solidity mode keymap by adding
35+
a new key combination for each command you want to change. For example
36+
37+
#+BEGIN_SRC lisp
38+
(define-key map (kbd "C-c C-g") 'solidity-estimate-gas-at-point)
39+
#+END_SRC
40+
3341
** Interface with linters
3442
*** Provide path to solc binary
3543
The =solc= binary is assumed to be part of the PATH. Wherever that is not the case you would have to manually
@@ -100,8 +108,16 @@ how they are chained. Its value can be either =t=, =error=, =warning= or =info=
100108
of the solc checker after which solium will not run. If =t= is given solium will always run. The default is =warning=, so
101109
if anything over than a warning is found in solc solium will not run.
102110

111+
* Commands
112+
113+
** Gas estimate of function under point
114+
You can get an estimate of the function under the cursor, by placing the curson
115+
on top of the function name and typing =C-c C-g=.
116+
117+
This will call =solidity-estimate-gas-at-point= and provide a max gas estimate,
118+
if possible, for the function.
103119
* Features
104120
+ Syntax highlighting
105121
+ Indentation
106122
+ On the fly syntax checking with flycheck
107-
More features are planned, which would interface with the solidity libraries.
123+
+ Gas estimation for function under point

0 commit comments

Comments
 (0)