Skip to content

Commit 3b94cd8

Browse files
authored
Merge pull request #1315 from o1-labs/dw/update-readme
README: update with links to new website
2 parents 975565f + 74f82a8 commit 3b94cd8

File tree

2 files changed

+52
-57
lines changed

2 files changed

+52
-57
lines changed

README.md

Lines changed: 52 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
11
<div align="center">
2-
<picture>
3-
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/OpenMinaGH_Light.svg">
4-
<source media="(prefers-color-scheme: light)" srcset="docs/assets/OpenMinaGH_Dark.svg">
5-
<img alt="The Open Mina Node is a fast and secure implementation of the Mina protocol in Rust."
6-
src="docs/assets/OpenMinaGH_Light.svg"
7-
width="152px">
8-
</picture>
2+
<img src="website/static/img/rust-node-social-card.svg" alt="Mina Rust Node - Fast and secure implementation of the Mina protocol in Rust" width="600px">
93

104
![Beta][beta-badge] [![release-badge]][release-link]
5+
![GitHub Repo stars](https://img.shields.io/github/stars/openmina/openmina?style=social)
116
[![Changelog][changelog-badge]][changelog] [![Apache licensed]][Apache link]
127

13-
_The **Open Mina Node** is a fast and secure implementation of the Mina protocol
8+
_The **Mina Rust Node** is a fast and secure implementation of the Mina protocol
149
in **Rust**._ _Currently in **public beta**, join our
1510
[Discord community](https://discord.com/channels/484437221055922177/1290662938734231552)
1611
to help test future releases._
@@ -19,26 +14,31 @@ to help test future releases._
1914

2015
---
2116

17+
## What is Mina Protocol?
18+
19+
Mina is a lightweight blockchain using zero-knowledge proofs to maintain a
20+
constant blockchain size, making it the world's lightest blockchain. Learn more
21+
at **[minaprotocol.com](https://minaprotocol.com)**.
22+
23+
## Quick Start
24+
25+
**[View full system requirements and setup instructions →](https://o1-labs.github.io/openmina/docs/node-operators/getting-started)**
26+
2227
## Getting Started
2328

24-
### Building from Source
29+
For comprehensive installation and setup instructions, visit our documentation
30+
website:
2531

26-
- [Rust Node](/docs/building-from-source-guide.md#how-to-build-and-launch-a-node-from-source)
27-
and [Dashboards](./docs/building-from-source-guide.md#how-to-launch-the-ui)
28-
- [Web Node](/docs/local-webnode.md)
32+
**[Complete Setup Guide →](https://o1-labs.github.io/openmina/docs/node-operators/getting-started)**
2933

30-
### Run Node on Devnet via Docker
34+
### Quick Links
3135

32-
- [Non-Block Producing Node](/docs/alpha-testing-guide.md) Connect to peers and
33-
sync a node on the devnet; no devnet stake needed.
34-
- [Block Producing Node](/docs/block-producer-guide.md) Produce blocks on the
35-
devnet; sufficient devnet stake needed.
36-
- [Local Block Production Demo](/docs/local-demo-guide.md) Produce blocks on a
37-
custom local chain without devnet stake.
38-
- [Devnet Archive Node](/docs/archive-node-guide.md) Run an archive node on
39-
devnet.
36+
- **[Docker Installation](https://o1-labs.github.io/openmina/docs/node-operators/docker-installation)**
37+
- **[Building from Source](https://o1-labs.github.io/openmina/docs/node-operators/building-from-source)**
38+
- **[Block Producer Setup](https://o1-labs.github.io/openmina/docs/node-operators/block-producer)**
39+
- **[Archive Node](https://o1-labs.github.io/openmina/docs/node-operators/archive-node)**
4040

41-
<img src="docs/assets/NodeUI.png" alt="Block production Node UI">
41+
<img src="website/static/img/NodeUI.png" alt="Block production Node UI">
4242

4343
---
4444

@@ -49,52 +49,47 @@ to help test future releases._
4949

5050
## Core Features
5151

52-
- **Mina Network**: Connect to peers, sync up, broadcast messages
53-
- **Block Production**: Produces, validates, and applies blocks according to
54-
Mina's consensus.
55-
- **SNARK Generation**: Produce SNARK proofs for transactions
56-
- **Debugging**: A block replayer that uses data from the archive nodes
52+
The Mina Rust Node implements the complete Mina protocol in Rust, including
53+
network connectivity, block production, SNARK generation, and debugging tools.
5754

58-
## Repository Structure
59-
60-
- [core/](core) - Provides basic types needed to be shared across different
61-
components of the node.
62-
- [ledger/](ledger) - Mina ledger implementation in Rust.
63-
- [snark/](snark) - Snark/Proof verification.
64-
- [p2p/](p2p) - P2p implementation for OpenMina node.
65-
- [node/](node) - Combines all the business logic of the node.
66-
- [native/](node/native) - OS specific pieces of the node, which is used to
67-
run the node natively (Linux/Mac/Windows).
68-
- [testing/](node/testing) - Testing framework for OpenMina node.
69-
- [cli/](cli) - OpenMina cli.
70-
- [frontend/](frontend) - OpenMina frontend.
55+
**[Learn More About Architecture →](https://o1-labs.github.io/openmina/docs/developers/getting-started)**
7156

72-
## The Open Mina Documentation
73-
74-
### What is Open Mina?
57+
## Repository Structure
7558

76-
- [Why we are developing Open Mina](docs/why-openmina.md)
59+
This repository contains the complete Mina Rust Node implementation:
7760

78-
### Core components
61+
- **[node/](node)** - Core node business logic and state machine
62+
- **[p2p/](p2p)** - Networking layer (libp2p + WebRTC)
63+
- **[ledger/](ledger)** - Ledger implementation and transaction processing
64+
- **[snark/](snark)** - SNARK proof verification
65+
- **[cli/](cli)** - Command-line interface
66+
- **[frontend/](frontend)** - Web-based node dashboard
7967

80-
- [P2P communication](https://github.com/openmina/openmina/blob/documentation/docs/p2p_service.md)
81-
- [GossipSub](https://github.com/openmina/mina-wiki/blob/3ea9041e52fb2e606918f6c60bd3a32b8652f016/p2p/mina-gossip.md)
82-
- [Scan state](docs/scan-state.md)
83-
- [SNARKs](docs/snark-work.md)
68+
**[Learn more about the architecture →](https://o1-labs.github.io/openmina/docs/developers/getting-started)**
8469

85-
### Developer tools
70+
## Community & Support
8671

87-
- [Front End](./docs/building-from-source-guide.md#how-to-launch-the-ui)
72+
**[Visit our comprehensive documentation website →](https://o1-labs.github.io/openmina)**
8873

89-
### Testing Framework for Mina
74+
### Get Help & Contribute
9075

91-
- [Full Testing Documentation](docs/testing/testing.md)
76+
- **[GitHub Discussions](https://github.com/openmina/openmina/discussions)** -
77+
Ask questions and share ideas
78+
- **[Issues](https://github.com/openmina/openmina/issues)** - Report bugs or
79+
request features
80+
- **[Discord Community](https://discord.com/channels/484437221055922177/1290662938734231552)** -
81+
Real-time support and testing
82+
- **[Contributing Guide](https://o1-labs.github.io/openmina/docs/developers/getting-started)** -
83+
How to contribute code
9284

93-
### How to run
85+
### Key Documentation Sections
9486

95-
- [Non-Block Producing Node](./docs/alpha-testing-guide.md)
96-
- [Block Producing Node](./docs/block-producer-guide.md)
97-
- [Local Block Production Demo](./docs/local-demo-guide.md)
87+
- **[Node Operators](https://o1-labs.github.io/openmina/docs/node-operators/getting-started)** -
88+
Installation and operation guides
89+
- **[Developers](https://o1-labs.github.io/openmina/docs/developers/getting-started)** -
90+
Architecture and contribution guides
91+
- **[API Documentation](https://o1-labs.github.io/openmina/api-docs/)** -
92+
Comprehensive API reference
9893

9994
[changelog]: ./CHANGELOG.md
10095
[beta-badge]: https://img.shields.io/badge/status-beta-yellow

website/static/img/NodeUI.png

963 KB
Loading

0 commit comments

Comments
 (0)