Skip to content

docs: Add README for agave-validator crate #8430

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+30 −0
Open

docs: Add README for agave-validator crate #8430

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions validator/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ repository = { workspace = true }
homepage = { workspace = true }
license = { workspace = true }
edition = { workspace = true }
readme = "README.md"

[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
Expand Down
29 changes: 29 additions & 0 deletions validator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Agave Validator

Agave is Anza's high-performance validator client for the Solana blockchain.

## About

This is the main validator implementation for running a Solana validator node. Agave is developed and maintained by Anza as part of the Solana ecosystem.

## Getting Started with Solana Development

**New to Solana?** Here are essential resources to get started:

### Documentation
- **Solana Official Docs**: https://docs.solana.com/
- **Agave Repository**: https://github.com/anza-xyz/agave
- **Solana Cookbook**: https://solanacookbook.com/

### For Developers
- **Building Programs**: https://docs.solana.com/developing/programming-model/overview
- **Solana Program Library**: https://github.com/solana-labs/solana-program-library
- **Anchor Framework**: https://www.anchor-lang.com/

### For Validator Operators
- **Running a Validator**: https://docs.solana.com/running-validator
- **Validator Guide**: https://docs.solanalabs.com/operations/guides/validator-start

## Installation
```bash
cargo install agave-validator