Skip to content

Commit 111b967

Browse files
authored
fix readme typo and format (tronprotocol#6556)
* fix readme typo and format
1 parent c158599 commit 111b967

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@
3131

3232
TRON is building the foundational infrastructure for the decentralized internet ecosystem with a focus on high-performance, scalability, and security.
3333

34-
- TRON Protocol: High-throughput2000+ TPS), scalable blockchain OS (DPoS consensus) powering the TRON ecosystem.
34+
- TRON Protocol: High-throughput (2000+ TPS), scalable blockchain OS (DPoS consensus) powering the TRON ecosystem.
3535
- TRON Virtual Machine (TVM): EVM-compatible smart-contract engine for fast smart-contract execution.
3636

3737
# Building the Source Code
3838
Before building java-tron, make sure you have:
3939
- Hardware with at least 4 CPU cores, 16 GB RAM, 10 GB free disk space for a smooth compilation process.
4040
- Operating system: `Linux` or `macOS` (`Windows` is not supported).
41-
- Git and correct JDKversion `8` or `17` installed based on your CPU architecture.
41+
- Git and correct JDK (version `8` or `17`) installed based on your CPU architecture.
4242

4343
There are two ways to install the required dependencies:
4444

@@ -128,7 +128,7 @@ tail -f ./logs/tron.log
128128
Use [TronScan](https://tronscan.org/#/), TRON's official block explorer, to view main network transactions, blocks, accounts, witness voting, and governance metrics, etc.
129129

130130
### 2. Join Nile test network
131-
Utilize the `-c` flag to direct the node to the configuration file corresponding to the desired network. Since Nile TestNet may incorporate features not yet available on the MainNet, it is **strongly advised** to compile the source code following the [Building the Source Code](https://github.com/tron-nile-testnet/nile-testnet/blob/master/README.md#building-the-source-code) instructions for the Nile TestNet.
131+
Utilize the `-c` flag to direct the node to the configuration file corresponding to the desired network. Since Nile Testnet may incorporate features not yet available on the Mainnet, it is **strongly advised** to compile the source code following the [Building the Source Code](https://github.com/tron-nile-testnet/nile-testnet/blob/master/README.md#building-the-source-code) instructions for the Nile Testnet.
132132

133133
```bash
134134
java -jar ./build/libs/FullNode.jar -c config-nile.conf
@@ -139,7 +139,7 @@ Nile resources: explorer, faucet, wallet, developer docs, and network statistics
139139
### 3. Access Shasta test network
140140
Shasta does not accept public node peers. Programmatic access is available via TronGrid endpoints; see [TronGrid Service](https://developers.tron.network/docs/trongrid) for details.
141141

142-
Shasta resources: explorer, faucet, wallet, developer docs, and network statistics at [shastaex.io](https://shasta.tronex.io/).
142+
Shasta resources: explorer, faucet, wallet, developer docs, and network statistics at [shasta.tronex.io](https://shasta.tronex.io/).
143143

144144
### 4. Set up a private network
145145
To set up a private network for testing or development, follow the [Private Network guidance](https://tronprotocol.github.io/documentation-en/using_javatron/private_network/).
@@ -160,7 +160,7 @@ You could also test the process by connecting to a testnet or setting up a priva
160160

161161
## Programmatically interfacing FullNode
162162

163-
Upon the FullNode startup successfully, interaction with the TRON network is facilitated through a comprehensive suite of programmatic interfaces exposed by java-tron:
163+
Once the FullNode starts successfully, interaction with the TRON network is facilitated through a comprehensive suite of programmatic interfaces exposed by java-tron:
164164
- **HTTP API**: See the complete [HTTP API reference and endpoint list](https://tronprotocol.github.io/documentation-en/api/http/).
165165
- **gRPC**: High-performance APIs suitable for service-to-service integration. See the supported [gRPC reference](https://tronprotocol.github.io/documentation-en/api/rpc/).
166166
- **JSON-RPC**: Provides Ethereum-compatible JSON-RPC methods for logs, transactions and contract calls, etc. See the supported [JSON-RPC methods](https://tronprotocol.github.io/documentation-en/api/json-rpc/).
@@ -201,14 +201,14 @@ Thank you for considering to help out with the source code! If you'd like to con
201201

202202
# Resources
203203

204-
- [Medium](https://medium.com/@coredevs) java-tron's official technical articles are published there.
204+
- [Medium](https://medium.com/@coredevs) - java-tron's official technical articles are published here.
205205
- [Documentation](https://tronprotocol.github.io/documentation-en/) and [TRON Developer Hub](https://developers.tron.network/) serve as java-tron’s primary documentation websites.
206-
- [TronScan](https://tronscan.org/#/) TRON main network blockchain browser.
207-
- [Nile Test network](http://nileex.io/) A stable test network of TRON contributed by TRON community.
208-
- [Shasta Test network](https://shasta.tronex.io/) A stable test network of TRON contributed by TRON community.
209-
- [Wallet-cli](https://github.com/tronprotocol/wallet-cli) TRON network wallet using command line.
210-
- [TIP](https://github.com/tronprotocol/tips) TRON Improvement Proposal (TIP) describes standards for the TRON network.
211-
- [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.
206+
- [TronScan](https://tronscan.org/) - TRON main network blockchain browser.
207+
- [Nile Test Network](https://nileex.io/) - Forward-looking testnet for developers to experience.
208+
- [Shasta Test Network](https://shasta.tronex.io/) - Stable testnet that closely mirrors Mainnet features, providing a realistic testing environment .
209+
- [Wallet-cli](https://github.com/tronprotocol/wallet-cli) - TRON network wallet using command line.
210+
- [TIP](https://github.com/tronprotocol/tips) - TRON Improvement Proposal (TIP) describes standards for the TRON network.
211+
- [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.
212212

213213
# Integrity Check
214214

0 commit comments

Comments
 (0)