cerc-io/solidity
10
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Techie Geek 2023-07-20 22:29:58 +01:00 committed by GitHub
parent f466e1ef5e
commit a65ca1f495
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
README.md
View File

@ -8,7 +8,7 @@
You can talk to us on Gitter and Matrix, tweet at us on Twitter or create a new topic in the Solidity forum. Questions, feedback, and suggestions are welcome! You can talk to us on Gitter and Matrix, tweet at us on Twitter or create a new topic in the Solidity forum. Questions, feedback, and suggestions are welcome!
Solidity is a statically typed, contract-oriented, high-level language for implementing smart contracts on the Ethereum platform. Solidity is a statically typed, contract-oriented, high-level language for implementing smart contracts on the Ethereum Virtual Machine.
For a good overview and starting point, please check out the official [Solidity Language Portal](https://soliditylang.org). For a good overview and starting point, please check out the official [Solidity Language Portal](https://soliditylang.org).
@ -26,53 +26,54 @@ For a good overview and starting point, please check out the official [Solidity
## Background ## Background
Solidity is a statically-typed curly-braces programming language designed for developing smart contracts Solidity is a statically-typed curly-braces programming language designed for developing smart contracts
that run on the Ethereum Virtual Machine. Smart contracts are programs that are executed inside a peer-to-peer which runs on the Ethereum Virtual Machine. Smart contracts are programs that are self-executed inside a peer-to-peer
network where nobody has special authority over the execution, and thus they allow anyone to implement tokens of value, network where nobody has special authority over the execution, and thus they allow anyone to implement tokens of value,
ownership, voting, and other kinds of logic. ownership, voting, and other kinds of logic.
When deploying contracts, you should use the latest released version of When deploying contracts, you should use the latest released version of
Solidity. This is because breaking changes, as well as new features and bug fixes, are Solidity. This is because breaking changes, as well as new features and bug fixes, are
introduced regularly. We currently use a 0.x version introduced regularly. We currently use a 0.x version
number [to indicate this fast pace of change](https://semver.org/#spec-item-4). number **to indicate this fast pace of change**(https://semver.org/#spec-item-4).
## Build and Install ## Build and Install
Instructions about how to build and install the Solidity compiler can be Instructions about how to build and install the Solidity compiler can be
found in the [Solidity documentation](https://docs.soliditylang.org/en/latest/installing-solidity.html#building-from-source). found in the **Solidity documentation**(https://docs.soliditylang.org/en/latest/installing-solidity.html#building-from-source).
## Example ## Example
A "Hello World" program in Solidity is of even less use than in other languages, but still: An "Hello World" program in Solidity is of even less use than in other languages, Here is it:
```solidity 1. ```solidity
// SPDX-License-Identifier: MIT 2. // SPDX-License-Identifier: MIT
pragma solidity >=0.6.0 <0.9.0; 3. pragma solidity >=0.6.0 <0.9.0;
4.
5. contract HelloWorld {
6. function helloWorld() external pure returns (string memory) {
7. return "Hello, World!";
8. }
9. }
10. ```
**NB**: Any Lincense can be used in plance of **MIT** in **Line 2**.
contract HelloWorld { To get started with Solidity, you can use **Remix**(https://remix.ethereum.org/), which is a
function helloWorld() external pure returns (string memory) {
return "Hello, World!";
}
}
```
To get started with Solidity, you can use [Remix](https://remix.ethereum.org/), which is a
browser-based IDE. Here are some example contracts: browser-based IDE. Here are some example contracts:
1. [Voting](https://docs.soliditylang.org/en/latest/solidity-by-example.html#voting) 1. **Voting**(https://docs.soliditylang.org/en/latest/solidity-by-example.html#voting).
2. [Blind Auction](https://docs.soliditylang.org/en/latest/solidity-by-example.html#blind-auction) 2. **Blind Auction**(https://docs.soliditylang.org/en/latest/solidity-by-example.html#blind-auction).
3. [Safe remote purchase](https://docs.soliditylang.org/en/latest/solidity-by-example.html#safe-remote-purchase) 3. **Safe remote purchase**(https://docs.soliditylang.org/en/latest/solidity-by-example.html#safe-remote-purchase).
4. [Micropayment Channel](https://docs.soliditylang.org/en/latest/solidity-by-example.html#micropayment-channel) 4. **Micropayment Channel**(https://docs.soliditylang.org/en/latest/solidity-by-example.html#micropayment-channel).
## Documentation ## Documentation
The Solidity documentation is hosted using [Read the Docs](https://docs.soliditylang.org). The Solidity documentation is hosted using **Read the Docs**[https://docs.soliditylang.org].
## Development ## Development
Solidity is still under development. Contributions are always welcome! **Solidity** is still under development. **Contributions** are **always** welcome!
Please follow the Please follow the
[Developers Guide](https://docs.soliditylang.org/en/latest/contributing.html) **Developers Guide**(https://docs.soliditylang.org/en/latest/contributing.html)
if you want to help. if you want to help.
You can find our current feature and bug priorities for forthcoming You can find our current feature and bug priorities for forthcoming
@ -80,13 +81,13 @@ releases in the [projects section](https://github.com/ethereum/solidity/projects
## Maintainers ## Maintainers
The Solidity programming language and compiler are open-source community projects governed by a core team. The Solidity programming language and compiler are open-source community projects governed by a core team.
The core team is sponsored by the [Ethereum Foundation](https://ethereum.foundation/). The core team is sponsored by the **Ethereum Foundation**(https://ethereum.foundation/).
## License ## License
Solidity is licensed under [GNU General Public License v3.0](LICENSE.txt). Solidity is licensed under **GNU General Public License v3.0** (LICENSE.txt).
Some third-party code has its [own licensing terms](cmake/templates/license.h.in). Some third-party code has **its own licensing terms** (cmake/templates/license.h.in).
## Security ## Security
The security policy may be [found here](SECURITY.md). The security policy may be found **here**(SECURITY.md).