solidity/README.md

36 lines
2.6 KiB
Markdown
Raw Normal View History

2015-09-03 22:36:58 +00:00
# The Solidity Contract-Oriented Programming Language
2015-10-05 10:43:57 +00:00
[![Join the chat at https://gitter.im/ethereum/solidity](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ethereum/solidity?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2015-08-21 11:14:44 +00:00
## Useful links
2015-08-21 11:16:40 +00:00
To get started you can find a basic introduction to the language in [Solidity Tutorial](https://ethereum.github.io/solidity/docs/home/).
2015-08-21 11:14:44 +00:00
2015-10-05 10:21:31 +00:00
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).
2015-08-21 11:14:44 +00:00
2015-08-21 12:26:21 +00:00
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.
2015-08-21 11:14:44 +00:00
2015-08-21 12:26:21 +00:00
[Changelog](https://github.com/ethereum/wiki/wiki/Solidity-Changelog)
2015-08-21 11:14:44 +00:00
2015-08-21 12:26:21 +00:00
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).
2015-08-21 12:03:53 +00:00
2015-08-21 11:14:44 +00:00
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
2015-10-05 10:07:38 +00:00
See the [Wiki](https://github.com/ethereum/webthree-umbrella/wiki) for build instructions, compatibility information and build tips.
2015-08-21 11:14:44 +00:00
2015-08-21 12:26:21 +00:00
## How to Contribute
2015-08-21 11:14:44 +00:00
### External Contributors
2015-08-21 11:16:40 +00:00
2015-08-21 11:14:44 +00:00
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**
2015-10-05 10:27:56 +00:00
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).