diff options
Diffstat (limited to 'docs/index.rst')
-rw-r--r-- | docs/index.rst | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..fab886c7 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,66 @@ +Solidity +======== + +Solidity is a high-level language whose syntax is similar to that of JavaScript +and it is designed to compile to code for the Ethereum Virtual Machine. +As you will see, it is quite easy to create contracts for voting, +crowdfunding, blind auctions, multi-signature wallets and more. + +.. note:: + The best way to try out Solidity right now is using the + `Browser-Based Compiler <https://chriseth.github.io/browser-solidity/>`_ + (it can take a while to load, please be patient). + +Useful links +------------ + +* `Ethereum <https://ethereum.org>`_ + +* `Browser-Based Compiler <https://chriseth.github.io/browser-solidity/>`_ + +* `Changelog <https://github.com/ethereum/wiki/wiki/Solidity-Changelog>`_ + +* `Story Backlog <https://www.pivotaltracker.com/n/projects/1189488>`_ + +* `Source Code <https://github.com/ethereum/solidity/>`_ + +* `Ethereum Stackexchange <https://ethereum.stackexchange.com/>`_ + +* `Gitter Chat <https://gitter.im/ethereum/solidity/>`_ + +Language Documentation +---------------------- + +On the next pages, we will first see a :ref:`simple smart contract <simple-smart-contract>` written +in Solidity followed by the basics about :ref:`blockchains <blockchain-basics>` +and the :ref:`Ethereum Virtual Machine <the-ethereum-virtual-machine>`. + +The next section will explain several *features* of Solidity by giving +useful :ref:`example contracts <voting>` +Remember that you can always try out the contracts +`in your browser <https://chriseth.github.io/browser-solidity>`_! + +The last and most extensive section will cover all aspects of Solidity in depth. + +If you still have questions, you can try searching or asking on the +`Ethereum Stackexchange <https://ethereum.stackexchange.com/>`_ +site, or come to our `gitter channel <https://gitter.im/ethereum/solidity/>`_. +Ideas for improving Solidity or this documentation are always welcome! + +See also `Russian version (русский перевод) <https://github.com/ethereum/wiki/wiki/%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE-%D0%BF%D0%BE-Solidity>`_. + +Contents +======== + +:ref:`Keyword Index <genindex>`, :ref:`Search Page <search>` + +.. toctree:: + :maxdepth: 2 + + introduction-to-smart-contracts.rst + installing-solidity.rst + solidity-by-example.rst + solidity-in-depth.rst + style-guide.rst + common-patterns.rst + frequently-asked-questions.rst |