diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..217b7f23 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# The Solidity Contract-Oriented Programming Language +[](https://gitter.im/ethereum/solidity?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +## Useful links + +To get started you can find a basic introduction to the language in the [Solidity Documentation](https://solidity.readthedocs.org). + +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/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/webthree-umbrella/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](https://github.com/ethereum/webthree-umbrella/blob/develop/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](https://github.com/ethereum/webthree-umbrella/blob/develop/CodingStandards.txt). |