aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorchriseth <c@ethdev.com>2015-12-08 04:16:25 +0800
committerchriseth <c@ethdev.com>2015-12-08 05:35:51 +0800
commit64fa9ca478b95970825e3b783275ee66cf848358 (patch)
tree0e968e61d604d86197151a69ad38d0d2b07daa80 /docs/index.rst
parentba8bc4565aa0e5c41be107a7bbae3b51c74679c6 (diff)
downloaddexon-solidity-64fa9ca478b95970825e3b783275ee66cf848358.tar.gz
dexon-solidity-64fa9ca478b95970825e3b783275ee66cf848358.tar.zst
dexon-solidity-64fa9ca478b95970825e3b783275ee66cf848358.zip
Imported documentation.
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 00000000..92cf24e3
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,42 @@
+Welcome to Solidity's documentation!
+====================================
+
+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>`_.
+
+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.
+
+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 or ideas for improving Solidity or this documentation,
+please feel free to come to out `gitter channel <https://gitter.im/ethereum/solidity/>`_.
+
+Index and Search
+==================
+
+* :ref:`genindex`
+* :ref:`search`
+
+Contents
+========
+
+.. toctree::
+ :maxdepth: 2
+
+ introduction-to-smart-contracts.rst
+ solidity-by-example.rst
+ solidity-in-depth.rst
+ style-guide.rst
+ common-patterns.rst
+ frequently-asked-questions.rst