aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorchriseth <c@ethdev.com>2015-08-21 22:32:51 +0800
committerchriseth <c@ethdev.com>2015-08-21 22:32:51 +0800
commitb999819d9938c248f060473ba13d3306a166a6f6 (patch)
treed5bde89e60a0489f7c627d1171b5d52962ec1ad7
parent7c81162d36164ac26269fd48439c5cfde61dae85 (diff)
parente14afe79ed1d9e3eda722f415fb430c29bedc170 (diff)
downloaddexon-solidity-b999819d9938c248f060473ba13d3306a166a6f6.tar.gz
dexon-solidity-b999819d9938c248f060473ba13d3306a166a6f6.tar.zst
dexon-solidity-b999819d9938c248f060473ba13d3306a166a6f6.zip
Merge pull request #20 from ethereum/readme.md-added
Updated README.md
-rw-r--r--README.md37
1 files changed, 35 insertions, 2 deletions
diff --git a/README.md b/README.md
index f3068674..60e49261 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,35 @@
-# solidity
-The Solidity Contract-Oriented Programming Langauge
+# The Solidity Contract-Oriented Programming Langauge
+
+## Useful links
+
+To get started you can find a basic introduction to the language in [Solidity Tutorial](https://github.com/ethereum/wiki/wiki/Solidity-Tutorial).
+
+You can start using [Solidity in your browser](https://chriseth.github.io/browser-solidity/) with no need to download or compile anything. This application only supports compilation - if you want to inject it into the blockchain, you have to use a client like [Geth](https://github.com/ethereum/go-ethereum/wiki) or [AlethZero](https://github.com/ethereum/cpp-ethereum/wiki/Using-AlethZero).
+
+Also check out more documentations for [Solidity ABI](https://github.com/ethereum/wiki/wiki/Solidity,-Docs-and-ABI) and a crowdfunding [example contract](https://github.com/chriseth/cpp-ethereum/wiki/Crowdfunding-example-contract-in-Solidity) written in Solidity.
+
+[Changelog](https://github.com/ethereum/wiki/wiki/Solidity-Changelog)
+
+The [Solidity Features](https://github.com/ethereum/wiki/wiki/Solidity-Features) page contains a list of already completed Solidity feature stories with explanations and demonstrations, it is being updated continuously. More technical information you can find in the [Pivotal Tracker](https://www.pivotaltracker.com/n/projects/1189488).
+
+Solidity is still under development. So please do not hesitate and open an [issue in github](https://github.com/ethereum/solidity/issues) if you encounter anything strange.
+
+## Building
+
+See the [Wiki](https://github.com/ethereum/cpp-ethereum/wiki) for build instructions, compatibility information and build tips.
+
+## How to Contribute
+
+### External Contributors
+
+I hereby place all my contributions in this codebase under an MIT
+licence, as specified [here](http://opensource.org/licenses/MIT).
+- *Name Surname* (**email@domain**)
+
+### Contribution guideline
+
+Please add yourself in the `@author` doxygen section of the file your are adding/editing
+with the same wording as the one you listed yourself in the external contributors section above,
+only replacing the word **contribution** by **file**
+
+Please read [CodingStandards.txt](CodingStandards.txt) thoroughly before making alterations to the code base. Please do *NOT* use an editor that automatically reformats whitespace away from astylerc or the formatting guidelines as described in [CodingStandards.txt](CodingStandards.txt).