Skip to content

Commit

Permalink
[README] update readme (neo-project#3649)
Browse files Browse the repository at this point in the history
* update readme

* fix path

* fix plugin path

* fix plugin path

* fix wallet path

* fix wrong path and remove non-existing path

* Apply suggestions from code review

Co-authored-by: nan01ab <[email protected]>

* Update README.md

Co-authored-by: nan01ab <[email protected]>

* Update README.md

Co-authored-by: nan01ab <[email protected]>

* Apply suggestions from code review

Co-authored-by: nan01ab <[email protected]>
Co-authored-by: Roman Khimov <[email protected]>

---------

Co-authored-by: Christopher Schuchardt <[email protected]>
Co-authored-by: nan01ab <[email protected]>
Co-authored-by: Shargon <[email protected]>
Co-authored-by: Roman Khimov <[email protected]>
  • Loading branch information
5 people authored Jan 1, 2025
1 parent 2d19af4 commit 8c3938d
Showing 1 changed file with 15 additions and 17 deletions.
32 changes: 15 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,23 +114,21 @@ An overview of the project folders can be seen below.

|Folder|Content|
|---|---|
|/src/neo/Consensus/| Classes used in the dBFT consensus algorithm, including the `ConsensusService` actor.|
|/src/neo/Cryptography/|General cryptography classes including ECC implementation.|
|/src/neo/IO/|Data structures used for caching and collection interaction.|
|/src/neo/Ledger/|Classes responsible for the state control, including the `MemoryPool` and `Blockchain` classes.|
|/src/neo/Network/|Peer-to-peer protocol implementation classes.|
|/src/neo/Persistence/|Classes used to allow other classes to access application state.|
|/src/neo/Plugins/|Interfaces used to extend Neo, including the storage interface.|
|/src/neo/SmartContract/|Native contracts, `ApplicationEngine`, `InteropService` and other smart-contract related classes.|
|/src/neo/VM/|Helper methods used to interact with the VM.|
|/src/neo/Wallet/|Wallet and account implementation.|
|/src/Neo.CLI/| `neo-cli` console application for the running a _FULL_ node.|
|/src/Neo.Extensions/| Extensions class to expand the existing functionality.|
|/src/Neo.Json/| Neo's JSON Specification classes.|
|/src/Neo.VM/|Neo base class virtual machine.|
|/src/plugins/| Include `ApplicationLogs`, `LevelDBStore`, `RpcServer`, `OracleService`, `DBFTPlugin` and more.|
|/tests/|All unit tests.|

|[/src/neo/Cryptography/](https://github.com/neo-project/neo/tree/master/src/Neo/Cryptography)|General cryptography implementation, including ECC.|
|[/src/neo/IO/](https://github.com/neo-project/neo/tree/master/src/Neo/IO)|Data structures used for caching and collection interaction.|
|[/src/neo/Ledger/](https://github.com/neo-project/neo/tree/master/src/Neo/Ledger)|Classes responsible for the state control, including the `MemoryPool` and `Blockchain`.|
|[/src/neo/Network/](https://github.com/neo-project/neo/tree/master/src/Neo/Network)|Peer-to-peer protocol implementation.|
|[/src/neo/Persistence/](https://github.com/neo-project/neo/tree/master/src/Neo/Persistence)|Classes used to allow other classes to access application state.|
|[/src/neo/Plugins/](https://github.com/neo-project/neo/tree/master/src/Neo/Plugins)|Interfaces used to extend Neo, including the storage interface.|
|[/src/neo/SmartContract/](https://github.com/neo-project/neo/tree/master/src/Neo/SmartContract)|Native contracts, `ApplicationEngine`, `InteropService` and other smart-contract related classes.|
|[/src/neo/VM/](https://github.com/neo-project/neo/tree/master/src/Neo/VM)|Helper methods used to interact with the VM.|
|[/src/neo/Wallets/](https://github.com/neo-project/neo/tree/master/src/Neo/Wallets)|Wallet and account implementation.|
|[/src/Neo.CLI/](https://github.com/neo-project/neo/tree/master/src/Neo.CLI)| `neo-cli` console application for running a _FULL_ node.|
|[/src/Neo.Extensions/](https://github.com/neo-project/neo/tree/master/src/Neo.Extensions)| Extensions to expand the existing functionality.|
|[/src/Neo.Json/](https://github.com/neo-project/neo/tree/master/src/Neo.Json)| Neo's JSON specification.|
|[/src/Neo.VM/](https://github.com/neo-project/neo/tree/master/src/Neo.VM)|Neo virtual machine.|
|[/src/plugins/](https://github.com/neo-project/neo/tree/master/src/Plugins)| Include `ApplicationLogs`, `LevelDBStore`, `RpcServer`, `OracleService`, `DBFTPlugin` and more.|
|[/tests/](https://github.com/neo-project/neo/tree/master/tests)|All unit tests.|

## Related projects
Code references are provided for all platform building blocks. That includes the base library, the VM, a command line application and the compiler.
Expand Down

0 comments on commit 8c3938d

Please sign in to comment.