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.

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

Open
wants to merge 14 commits into
base: master
Choose a base branch
from

Conversation

cschuchardt88
Copy link
Member

neo-logo

               

(C#) implementation of the Neo Blockchain Protocol.

Current neo version. GitHub Issues or Pull Requests Coverage Status GitHub code size in bytes

Open in GitHub Codespaces.

Navigate

  1. Tutorials
  2. Bounty Program
  3. Opening a New Issue
  4. Project Structure
  5. Related Projects
  6. Contributor Guide
  7. License

Overview

This repository is the (C#) implementation of the Neo Clockchain. It is jointly maintained by the Neo Core Developers and Neo Global Development (NGD) community.

Visit tutorials to get started.

Project structure

An overview of the project folders can be seen below.

Folder Content
/src/neo/Cryptography/ General cryptography implementation, including ECC.
/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.
/src/neo/Network/ Peer-to-peer protocol implementation.
/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/Wallets/ Wallet and account implementation.
/src/Neo.CLI/ neo-cli console application for running a FULL node.
/src/Neo.Extensions/ Extensions to expand the existing functionality.
/src/Neo.Json/ Neo's JSON specification.
/src/Neo.VM/ Neo 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: Included libraries are Neo, Neo-CLI, Neo-GUI, Neo-VM, test and plugin modules.
  • neo-express: A private net optimized for development scenarios.
  • neo-devpack-dotnet: These are the official tools used to convert a C# smart-contract into a neo executable file.
  • neo-proposals: NEO Enhancement Proposals (NEPs) describe standards for the NEO platform, including core protocol specifications, client APIs, and contract standards.
  • neo-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.

If you found a security issue, please refer to our security policy.

Bounty program

You can be rewarded by finding security issues. Please refer to our bounty program page for more information.



Copyright © 2015-2025
Express · Proposals · Compiler · Read Docs
A modern distributed network for the Smart Economy



## Table of Contents
1. [Overview](#overview)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview still here

Copy link
Member Author

@cschuchardt88 cschuchardt88 Feb 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but it's not important link to have. It already at the top of the page and in the file. Your not going to goto the index to search for chapter 1 in a book are you?


## Overview
This repository is a csharp implementation of the [neo](https://neo.org) blockchain. It is jointly maintained by the neo core developers and neo global development community.
Visit the [tutorials](https://docs.neo.org) to get started.
This repository is the (C#) implementation of the [Neo](https://neo.org) Clockchain. It is jointly maintained by the [Neo Core Developers](https://github.com/orgs/neo-project/teams/core) and Neo Global Development (NGD) community.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clockchain is something different.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lol oops

<br />
<a href="https://github.com/neo-project/neo-express"><strong>Express</strong></a>
·
<a href="https://github.com/neo-project/proposals"><strong>Proposals</strong></a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure about these links, having that at the bottom doesn't help much (anything after (c) will be skipped often) and we don't explain what "proposals" are or what "express" is. Maybe .github info is sufficient for the purpose.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already say in Related projects section, what these are.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants