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

docs: enhance README with contributing guidelines and technical details #97

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
+49 −2
Open

docs: enhance README with contributing guidelines and technical details #97

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
51 changes: 49 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,58 @@ Continue reading [here](https://docs.0g.ai/intro) if you want to learn more abou

- If you want to run a validator node, DA node, or storage node, please refer to the [Run a Node Documentation](https://docs.0g.ai/run-a-node/overview).

## Getting Started
To get started with 0G Chain, you'll need to:
1. Read our [documentation](https://docs.0g.ai/intro)
2. Choose which component you want to work with (DA, Storage, Inference Serving, or Network)
3. Follow the setup instructions in the relevant documentation section

## Contributing
We welcome contributions from the community! Here's how you can contribute:

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

Please make sure to:
- Follow our coding standards
- Write clear commit messages
- Update documentation as needed
- Add tests for new features

## Technical Overview
0G Chain consists of several key components:

### Data Availability (DA) Layer
- Ultra high-performance with KZG commitments
- Quorum-based Data Availability Sampling
- Optimized for AI workloads

### Decentralized Storage
- Erasure coding for data reliability
- Efficient replication mechanisms
- Optimized for large-scale AI models

### Inference Serving
- Flexible framework for AI model deployment
- Support for model fine-tuning
- Distributed inference capabilities

### Network Layer
- High-performance P2P communication
- Low-latency data transfer
- Decentralized architecture

## Support and Additional Resources
We want to do everything we can to help you be successful while working on your contribution and projects. Here you'll find various resources and communities that may help you complete a project or contribute to 0G.
We're here to help you succeed in contributing to and building with 0G Chain:

### Official Links
- [Official Website](https://0g.ai)
- [Technical Documentation](https://docs.0g.ai)
- [GitHub Repository](https://github.com/0glabs)

### Communities
- [0G Telegram](https://t.me/web3_0glabs)
- [0G Discord](https://discord.com/invite/0glabs)
- [0G Discord](https://discord.com/invite/0glabs)