fix(docs/readme): minor grammar fixes to the README file (#5606)

tronprotocol · Dec 13, 2023 · 5815337 · 5815337
1 parent 3f3ffe9
commit 5815337
Showing 1 changed file with 81 additions and 60 deletions.
diff --git a/README.md b/README.md
@@ -10,7 +10,6 @@
   Java implementation of the <a href="https://tron.network">Tron Protocol</a>
 </h4>
 
-
 <p align="center">
   <a href="https://gitter.im/tronprotocol/allcoredev">
     <img src="https://camo.githubusercontent.com/da2edb525cde1455a622c58c0effc3a90b9a181c/68747470733a2f2f6261646765732e6769747465722e696d2f4a6f696e253230436861742e737667">
@@ -42,6 +41,7 @@
 </p>
 
 ## Table of Contents
+
 - [What’s TRON?](#whats-tron)
 - [Building the Source Code](#building-the-source)
 - [Running java-tron](#running-java-tron)
@@ -55,94 +55,109 @@
 
 TRON is a project dedicated to building the infrastructure for a truly decentralized Internet.
 
-* Tron Protocol, one of the largest blockchain-based operating systems in the world, offers scalable, high-availability and high-throughput support that underlies all the decentralized applications in the TRON ecosystem.
+- Tron Protocol, one of the largest blockchain-based operating systems in the world, offers scalable, high-availability and high-throughput support that underlies all the decentralized applications in the TRON ecosystem.
 
-* Tron Virtual Machine (TVM) allows anyone to develop decentralized applications (DAPPs) for themselves or their communities with smart contracts thereby making decentralized crowdfunding and token issuance easier than ever.
+- Tron Virtual Machine (TVM) allows anyone to develop decentralized applications (DAPPs) for themselves or their communities with smart contracts thereby making decentralized crowdfunding and token issuance easier than ever.
 
 TRON enables large-scale development and engagement. With over 2000 transactions per second (TPS), high concurrency, low latency, and massive data transmission. It is ideal for building decentralized entertainment applications. Free features and incentive systems allow developers to create premium app experiences for users.
 
 # Building the source
+
 Building java-tron requires `git` and 64-bit version of `Oracle JDK 1.8` to be installed, other JDK versions are not supported yet. Make sure you operate on `Linux` and `MacOS` operating systems.
 
 Clone the repo and switch to the `master` branch
 
-  ```bash
-  $ git clone https://github.com/tronprotocol/java-tron.git
-  $ cd java-tron
-  $ git checkout -t origin/master
-  ```
+```bash
+$ git clone https://github.com/tronprotocol/java-tron.git
+$ cd java-tron
+$ git checkout -t origin/master
+```
+
 then run the following command to build java-tron, the `FullNode.jar` file can be found in `java-tron/build/libs/` after build successful.
+
 ```bash
 $ ./gradlew clean build -x test
 ```
 
-
 # Running java-tron
+
 Running java-tron requires 64-bit version of `Oracle JDK 1.8` to be installed, other JDK versions are not supported yet. Make sure you operate on `Linux` and `MacOS` operating systems.
 
-Get the mainnet configuration file: [main_net_config.conf](https://github.com/tronprotocol/tron-deployment/blob/master/main_net_config.conf), other network configuration files can be find [here](https://github.com/tronprotocol/tron-deployment).
+Get the mainnet configuration file: [main_net_config.conf](https://github.com/tronprotocol/tron-deployment/blob/master/main_net_config.conf), other network configuration files can be found [here](https://github.com/tronprotocol/tron-deployment).
+
 ## Hardware Requirements
+
 Minimum:
-* CPU with 8 cores
-* 16GB RAM
-* 2TB free storage space to sync the Mainnet
+
+- CPU with 8 cores
+- 16GB RAM
+- 2TB free storage space to sync the Mainnet
 
 Recommended:
-* CPU with 16+ cores(32+ cores for a super representative)
-* 32GB+ RAM(64GB+ for a super representative)
-* High Performance SSD with at least 2.5TB free space
-* 100+ MB/s download Internet service
 
+- CPU with 16+ cores(32+ cores for a super representative)
+- 32GB+ RAM(64GB+ for a super representative)
+- High Performance SSD with at least 2.5TB free space
+- 100+ MB/s download Internet service
 
 ## Running a full node for mainnet
-Full node has full historical data, it is the entry point into the TRON network , it can be used by other processes as a gateway into the TRON network via HTTP and GRPC endpoints. You can interact with the TRON network through full node：transfer assets, deploy contracts, interact with contracts and so on. `-c ` parameter specifies a configuration file to run a full node:
-   ```bash
-   $ nohup java -Xms9G -Xmx9G -XX:ReservedCodeCacheSize=256m \
-                -XX:MetaspaceSize=256m -XX:MaxMetaspaceSize=512m \
-                -XX:MaxDirectMemorySize=1G -XX:+PrintGCDetails \
-                -XX:+PrintGCDateStamps  -Xloggc:gc.log \
-                -XX:+UseConcMarkSweepGC -XX:NewRatio=2 \
-                -XX:+CMSScavengeBeforeRemark -XX:+ParallelRefProcEnabled \
-                -XX:+HeapDumpOnOutOfMemoryError \
-                -XX:+UseCMSInitiatingOccupancyOnly  -XX:CMSInitiatingOccupancyFraction=70 \
-                -jar FullNode.jar -c main_net_config.conf >> start.log 2>&1 &
-   ```
+
+Full node has full historical data, it is the entry point into the TRON network , it can be used by other processes as a gateway into the TRON network via HTTP and GRPC endpoints. You can interact with the TRON network through full node：transfer assets, deploy contracts, interact with contracts and so on. `-c` parameter specifies a configuration file to run a full node:
+
+```bash
+$ nohup java -Xms9G -Xmx9G -XX:ReservedCodeCacheSize=256m \
+             -XX:MetaspaceSize=256m -XX:MaxMetaspaceSize=512m \
+             -XX:MaxDirectMemorySize=1G -XX:+PrintGCDetails \
+             -XX:+PrintGCDateStamps  -Xloggc:gc.log \
+             -XX:+UseConcMarkSweepGC -XX:NewRatio=2 \
+             -XX:+CMSScavengeBeforeRemark -XX:+ParallelRefProcEnabled \
+             -XX:+HeapDumpOnOutOfMemoryError \
+             -XX:+UseCMSInitiatingOccupancyOnly  -XX:CMSInitiatingOccupancyFraction=70 \
+             -jar FullNode.jar -c main_net_config.conf >> start.log 2>&1 &
+```
+
 ## Running a super representative node for mainnet
-Adding the `--witness` parameter to the startup command, full node will run as a super representative node. The super representative node supports all the functions of the full node and also supports block production. Before running, make sure you have a super representative account and get votes from others，once the number of obtained votes ranks in the top 27, your super representative node will participate in block production.
 
-Fill in the private key of super representative address into the `localwitness` list in the `main_net_config.conf`, here is an example:
-   ```
-    localwitness = [
-        650950B193DDDDB35B6E48912DD28F7AB0E7140C1BFDEFD493348F02295BD812
-    ]
-   ```
+Adding the `--witness` parameter to the startup command, full node will run as a super representative node. The super representative node supports all the functions of the full node and also supports block production. Before running, make sure you have a super representative account and get votes from others. Once the number of obtained votes ranks in the top 27, your super representative node will participate in block production.
+
+Fill in the private key of super representative address into the `localwitness` list in the `main_net_config.conf`. Here is an example:
+
+```
+ localwitness = [
+     650950B193DDDDB35B6E48912DD28F7AB0E7140C1BFDEFD493348F02295BD812
+ ]
+```
 
 then run the following command to start the node:
-  ```bash
-  $ nohup java -Xms9G -Xmx9G -XX:ReservedCodeCacheSize=256m \
-               -XX:MetaspaceSize=256m -XX:MaxMetaspaceSize=512m \
-               -XX:MaxDirectMemorySize=1G -XX:+PrintGCDetails \
-               -XX:+PrintGCDateStamps  -Xloggc:gc.log \
-               -XX:+UseConcMarkSweepGC -XX:NewRatio=2 \
-               -XX:+CMSScavengeBeforeRemark -XX:+ParallelRefProcEnabled \
-               -XX:+HeapDumpOnOutOfMemoryError \
-               -XX:+UseCMSInitiatingOccupancyOnly  -XX:CMSInitiatingOccupancyFraction=70 \
-               -jar FullNode.jar --witness -c main_net_config.conf >> start.log 2>&1 &
-   ```
+
+```bash
+$ nohup java -Xms9G -Xmx9G -XX:ReservedCodeCacheSize=256m \
+             -XX:MetaspaceSize=256m -XX:MaxMetaspaceSize=512m \
+             -XX:MaxDirectMemorySize=1G -XX:+PrintGCDetails \
+             -XX:+PrintGCDateStamps  -Xloggc:gc.log \
+             -XX:+UseConcMarkSweepGC -XX:NewRatio=2 \
+             -XX:+CMSScavengeBeforeRemark -XX:+ParallelRefProcEnabled \
+             -XX:+HeapDumpOnOutOfMemoryError \
+             -XX:+UseCMSInitiatingOccupancyOnly  -XX:CMSInitiatingOccupancyFraction=70 \
+             -jar FullNode.jar --witness -c main_net_config.conf >> start.log 2>&1 &
+```
 
 ## Quick Start Tool
-An easier way to build and run java-tron is to use `start.sh`, `start.sh` is a quick start script written in shell language, you can use it to build and run java-tron quickly and easily.
+
+An easier way to build and run java-tron is to use `start.sh`. `start.sh` is a quick start script written in the Shell language. You can use it to build and run java-tron quickly and easily.
 
 Here are some common use cases of the scripting tool
-* Use `start.sh` to start a full node with the downloaded `FullNode.jar`
-* Use `start.sh` to download the latest `FullNode.jar` and start a full node.
-* Use `start.sh` to download the latest source code and compile a `FullNode.jar` and then start a full node.
+
+- Use `start.sh` to start a full node with the downloaded `FullNode.jar`
+- Use `start.sh` to download the latest `FullNode.jar` and start a full node.
+- Use `start.sh` to download the latest source code and compile a `FullNode.jar` and then start a full node.
 
 For more details, please refer to the tool [guide](./shell.md).
 
 ## Run inside Docker container
 
 One of the quickest ways to get `java-tron` up and running on your machine is by using Docker:
+
 ```shell
 $ docker run -d --name="java-tron" \
              -v /your_path/output-directory:/java-tron/output-directory \
@@ -155,29 +170,35 @@ $ docker run -d --name="java-tron" \
 This will mount the `output-directory` and `logs` directories on the host, the docker.sh tool can also be used to simplify the use of docker, see more [here](docker/docker.md).
 
 # Community
+
 [Tron Developers & SRs](https://discord.gg/hqKvyAM) is Tron's official Discord channel. Feel free to join this channel if you have any questions.
 
 [Core Devs Community](https://t.me/troncoredevscommunity) is the Telegram channel for java-tron community developers. If you want to contribute to java-tron, please join this channel.
 
 [tronprotocol/allcoredev](https://gitter.im/tronprotocol/allcoredev) is the official Gitter channel for developers.
 
 # Contribution
-Thank you for considering to help out with the source code! If you'd like to contribute to java-tron, please see the [Contribution Guide](./CONTRIBUTING.md) for more details.
 
+Thank you for considering to help out with the source code! If you'd like to contribute to java-tron, please see the [Contribution Guide](./CONTRIBUTING.md) for more details.
 
 # Resources
-* [Medium](https://medium.com/@coredevs) java-tron's official technical articles are published there.
-* [Documentation](https://tronprotocol.github.io/documentation-en/introduction/) java-tron's official technical documentation website.
-* [Test network](http://nileex.io/) A stable test network of TRON contributed by TRON community.
-* [Tronscan](https://tronscan.org/#/) TRON network blockchain browser.
-* [Wallet-cli](https://github.com/tronprotocol/wallet-cli) TRON network wallet using command line.
-* [TIP](https://github.com/tronprotocol/tips) TRON Improvement Proposal (TIP) describes standards for the TRON network.
-* [TP](https://github.com/tronprotocol/tips/tree/master/tp) TRON Protocol (TP) describes standards already implemented in TRON network but not published as a TIP.
+
+- [Medium](https://medium.com/@coredevs) java-tron's official technical articles are published there.
+- [Documentation](https://tronprotocol.github.io/documentation-en/introduction/) java-tron's official technical documentation website.
+- [Test network](http://nileex.io/) A stable test network of TRON contributed by TRON community.
+- [Tronscan](https://tronscan.org/#/) TRON network blockchain browser.
+- [Wallet-cli](https://github.com/tronprotocol/wallet-cli) TRON network wallet using command line.
+- [TIP](https://github.com/tronprotocol/tips) TRON Improvement Proposal (TIP) describes standards for the TRON network.
+- [TP](https://github.com/tronprotocol/tips/tree/master/tp) TRON Protocol (TP) describes standards already implemented in TRON network but not published as a TIP.
+
 # Integrity Check
-* After January 3, 2023， releases are signed the gpg key:
+
+- After January 3, 2023， releases are signed the gpg key:
   ```
   pub: 1254 F859 D2B1 BD9F 66E7 107D F859 BCB4 4A28 290B
   uid: [email protected]
   ```
+
 # License
+
 java-tron is released under the [LGPLv3 license](https://github.com/tronprotocol/java-tron/blob/master/LICENSE).