Skip to content

Commit 7b5595b

Browse files
authored
Merge pull request #11775 from ethereum/docs-resources
[DOCS] Update resources.rst
2 parents 990a072 + a2e73d7 commit 7b5595b

File tree

1 file changed

+50
-42
lines changed

1 file changed

+50
-42
lines changed

docs/resources.rst

Lines changed: 50 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,49 @@
1+
#########
12
Resources
2-
---------
3+
#########
34

4-
General
5-
~~~~~~~
5+
General Resources
6+
=================
67

7-
* `Ethereum <https://ethereum.org>`_
8+
* `Ethereum.org Developer Portal <https://ethereum.org/en/developers/>`_
9+
* `Ethereum StackExchange <https://ethereum.stackexchange.com/>`_
10+
* `Solidity Portal <https://soliditylang.org/>`_
11+
* `Solidity Changelog <https://github.com/ethereum/solidity/blob/develop/Changelog.md>`_
12+
* `Solidity Source Code on GitHub <https://github.com/ethereum/solidity/>`_
13+
* `Solidity Language Users Chat <https://matrix.to/#/#ethereum_solidity:gitter.im>`_
14+
* `Solidity Compiler Developers Chat <https://matrix.to/#/#ethereum_solidity-dev:gitter.im>`_
15+
* `Awesome Solidity <https://github.com/bkrem/awesome-solidity>`_
16+
* `Solidity by Example <https://solidity-by-example.org/>`_
817

9-
* `Changelog <https://github.com/ethereum/solidity/blob/develop/Changelog.md>`_
1018

11-
* `Source Code <https://github.com/ethereum/solidity/>`_
19+
Integrated (Ethereum) Development Environments
20+
==============================================
1221

13-
* `Ethereum Stackexchange <https://ethereum.stackexchange.com/>`_
22+
* `Brownie <https://eth-brownie.readthedocs.io/en/stable/>`_
23+
Python-based development and testing framework for smart contracts targeting the Ethereum Virtual Machine.
1424

15-
* `Language Users Chat <https://gitter.im/ethereum/solidity/>`_
25+
* `Dapp <https://dapp.tools/>`_
26+
Tool for building, testing and deploying smart contracts from the command line.
1627

17-
* `Compiler Developers Chat <https://gitter.im/ethereum/solidity-dev/>`_
28+
* `Embark <https://framework.embarklabs.io/>`_
29+
Developer platform for building and deploying decentralized applications.
1830

19-
Solidity Integrations
20-
~~~~~~~~~~~~~~~~~~~~~
21-
22-
* Generic:
23-
24-
* `EthFiddle <https://ethfiddle.com/>`_
25-
Solidity IDE in the Browser. Write and share your Solidity code. Uses server-side components.
31+
* `Hardhat <https://hardhat.org/>`_
32+
Ethereum development environment with local Ethereum network, debugging features and plugin ecosystem.
2633

2734
* `Remix <https://remix.ethereum.org/>`_
2835
Browser-based IDE with integrated compiler and Solidity runtime environment without server-side components.
2936

30-
* `Solhint <https://github.com/protofire/solhint>`_
31-
Solidity linter that provides security, style guide and best practice rules for smart contract validation.
37+
* `Scaffold-ETH <https://github.com/austintgriffith/scaffold-eth>`_
38+
Ethereum development stack focused on fast product iterations.
3239

33-
* `Solidity IDE <https://github.com/System-Glitch/Solidity-IDE>`_
34-
Browser-based IDE with integrated compiler, Ganache and local file system support.
40+
* `Truffle <https://www.trufflesuite.com/truffle>`_
41+
Ethereum development framework.
3542

36-
* `Ethlint <https://github.com/duaraghav8/Ethlint>`_
37-
Linter to identify and fix style and security issues in Solidity.
43+
Editor Integrations
44+
===================
3845

39-
* `Superblocks Lab <https://lab.superblocks.com/>`_
40-
Browser-based IDE. Built-in browser-based VM and Metamask integration (one click deployment to Testnet/Mainnet).
41-
42-
* Atom:
46+
* Atom
4347

4448
* `Etheratom <https://github.com/0mkara/etheratom>`_
4549
Plugin for the Atom editor that features syntax highlighting, compilation and a runtime environment (Backend node & VM compatible).
@@ -50,63 +54,67 @@ Solidity Integrations
5054
* `Atom Solium Linter <https://atom.io/packages/linter-solium>`_
5155
Configurable Solidity linter for Atom using Solium (now Ethlint) as a base.
5256

53-
* Eclipse:
54-
55-
* `YAKINDU Solidity Tools <https://yakindu.github.io/solidity-ide/>`_
56-
Eclipse based IDE. Features context sensitive code completion and help, code navigation, syntax coloring, built in compiler, quick fixes and templates.
57-
58-
* Emacs:
57+
* Emacs
5958

6059
* `Emacs Solidity <https://github.com/ethereum/emacs-solidity/>`_
6160
Plugin for the Emacs editor providing syntax highlighting and compilation error reporting.
6261

63-
* IntelliJ:
62+
* IntelliJ
6463

6564
* `IntelliJ IDEA plugin <https://plugins.jetbrains.com/plugin/9475-intellij-solidity>`_
6665
Solidity plugin for IntelliJ IDEA (and all other JetBrains IDEs)
6766

68-
* Sublime:
67+
* Sublime
6968

7069
* `Package for SublimeText - Solidity language syntax <https://packagecontrol.io/packages/Ethereum/>`_
7170
Solidity syntax highlighting for SublimeText editor.
7271

73-
* Vim:
72+
* Vim
7473

7574
* `Vim Solidity <https://github.com/tomlion/vim-solidity/>`_
7675
Plugin for the Vim editor providing syntax highlighting.
7776

7877
* `Vim Syntastic <https://github.com/vim-syntastic/syntastic>`_
7978
Plugin for the Vim editor providing compile checking.
8079

81-
* Visual Studio Code:
80+
* Visual Studio Code
8281

8382
* `Visual Studio Code extension <https://juan.blanco.ws/solidity-contracts-in-visual-studio-code/>`_
8483
Solidity plugin for Microsoft Visual Studio Code that includes syntax highlighting and the Solidity compiler.
8584

8685
Solidity Tools
87-
~~~~~~~~~~~~~~
86+
==============
8887

8988
* `ABI to Solidity interface converter <https://gist.github.com/chriseth/8f533d133fa0c15b0d6eaf3ec502c82b>`_
9089
A script for generating contract interfaces from the ABI of a smart contract.
9190

92-
* `Dapp <https://dapp.tools/dapp/>`_
93-
Build tool, package manager, and deployment assistant for Solidity.
91+
* `abi-to-sol <https://github.com/gnidan/abi-to-sol>`_
92+
Tool to generate Solidity interface source from a given ABI JSON.
9493

9594
* `Doxity <https://github.com/DigixGlobal/doxity>`_
9695
Documentation Generator for Solidity.
9796

97+
* `Ethlint <https://github.com/duaraghav8/Ethlint>`_
98+
Linter to identify and fix style and security issues in Solidity.
99+
98100
* `evmdis <https://github.com/Arachnid/evmdis>`_
99101
EVM Disassembler that performs static analysis on the bytecode to provide a higher level of abstraction than raw EVM operations.
100102

101103
* `EVM Lab <https://github.com/ethereum/evmlab/>`_
102104
Rich tool package to interact with the EVM. Includes a VM, Etherchain API, and a trace-viewer with gas cost display.
103105

106+
* `hevm <https://github.com/dapphub/dapptools/tree/master/src/hevm#readme>`_
107+
EVM debugger and symbolic execution engine.
108+
104109
* `leafleth <https://github.com/clemlak/leafleth>`_
105110
A documentation generator for Solidity smart-contracts.
106111

107112
* `PIET <https://piet.slock.it/>`_
108113
A tool to develop, audit and use Solidity smart contracts through a simple graphical interface.
109114

115+
* `sol2uml <https://www.npmjs.com/package/sol2uml>`_
116+
Unified Modeling Language (UML) class diagram generator for Solidity contracts.
117+
110118
* `solc-select <https://github.com/crytic/solc-select>`_
111119
A script to quickly switch between Solidity compiler versions.
112120

@@ -119,8 +127,8 @@ Solidity Tools
119127
* `solgraph <https://github.com/raineorshine/solgraph>`_
120128
Visualize Solidity control flow and highlight potential security vulnerabilities.
121129

122-
* `Securify <https://securify.ch/>`_
123-
Fully automated online static analyzer for smart contracts, providing a security report based on vulnerability patterns.
130+
* `Solhint <https://github.com/protofire/solhint>`_
131+
Solidity linter that provides security, style guide and best practice rules for smart contract validation.
124132

125133
* `Sūrya <https://github.com/ConsenSys/surya/>`_
126134
Utility tool for smart contract systems, offering a number of visual outputs and information about the contracts' structure. Also supports querying the function call graph.
@@ -129,7 +137,7 @@ Solidity Tools
129137
A tool for mutation generation, with configurable rules and support for Solidity and Vyper.
130138

131139
Third-Party Solidity Parsers and Grammars
132-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
140+
=========================================
133141

134142
* `Solidity Parser for JavaScript <https://github.com/solidity-parser/parser>`_
135143
A Solidity parser for JS built on top of a robust ANTLR4 grammar.

0 commit comments

Comments
 (0)