Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme.md #3609

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+20 −12
Open

Update Readme.md #3609

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
065fb13
Update Readme.md
cschuchardt88 Dec 4, 2024
2ca5dea
Update `ReadMe.md`
cschuchardt88 Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 20 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,24 +114,32 @@ An overview of the project folders can be seen below.

|Folder|Content|
|---|---|
|Consensus| Classes used in the dBFT consensus algorithm, including the `ConsensusService` actor.|
|Cryptography|General cryptography classes including ECC implementation.|
|IO|Data structures used for caching and collection interaction.|
|Ledger|Classes responsible for the state control, including the `MemoryPool` and `Blockchain` classes.|
|Network|Peer-to-peer protocol implementation classes.|
|Persistence|Classes used to allow other classes to access application state.|
|Plugins|Interfaces used to extend Neo, including the storage interface.|
|SmartContract|Native contracts, `ApplicationEngine`, `InteropService` and other smart-contract related classes.|
|VM|Helper methods used to interact with the VM.|
|Wallet|Wallet and account implementation. |
|/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.|


## 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.

* [neo:](https://github.com/neo-project/neo/) Neo core library, contains base classes, including ledger, p2p and IO modules.
* [neo-modules:](https://github.com/neo-project/neo-modules/) Neo modules include additional tools and plugins to be used with Neo.
* [neo:](https://github.com/neo-project/neo/) Included libraries are Neo, Neo-CLI, Neo-GUI, Neo-VM, test and plugin modules.
* [neo-express:](https://github.com/neo-project/neo-express/) A private net optimized for development scenarios.
* [neo-devpack-dotnet:](https://github.com/neo-project/neo-devpack-dotnet/) These are the official tools used to convert a C# smart-contract into a *neo executable file*.
cschuchardt88 marked this conversation as resolved.
Show resolved Hide resolved
* [neo-proposals:](https://github.com/neo-project/proposals) NEO Enhancement Proposals (NEPs) describe standards for the NEO platform, including core protocol specifications, client APIs, and contract standards.
* [neo-non-native-contracts:](https://github.com/neo-project/non-native-contracts) Includes non-native contracts that live on the blockchain, included but not limited to NeoNameService.

## Opening a new issue
Please feel free to create new issues to suggest features or ask questions.
Expand Down
Loading