mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
Update README.md
This commit is contained in:
parent
289b814670
commit
2251df7f61
32
README.md
32
README.md
@ -1,2 +1,34 @@
|
||||
# solidity
|
||||
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).
|
||||
|
||||
Check out [Solidity Features](https://github.com/ethereum/wiki/wiki/Solidity-Features) page with the list of already completed Solidity features 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).
|
||||
|
||||
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 run the code or 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.
|
||||
|
||||
You can find the changelog [here](https://github.com/ethereum/wiki/wiki/Solidity-Changelog).
|
||||
|
||||
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.
|
||||
|
||||
## Contributions
|
||||
|
||||
### 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).
|
||||
|
Loading…
Reference in New Issue
Block a user