Logo
Explore Help
Sign In
gaspersic/solana
1
0
Fork 0
You've already forked solana
Code Issues Pull Requests Projects Releases Wiki Activity
Files
2af5aad0322b74bb418fa2fa1fe01d2fed49cc75
solana/doc/README.md

26 lines
253 B
Markdown
Raw Normal View History

Stub out architecture book (#1674) * Stub out architecture documentation * Add book HTML generation and book tests to CI * Add heading * Better table of contents * Reference existing documentation Move ASCII art from code comments into rendered SVG * Attempt to fix CI * Add lamport docs And truncate lines to 80 characters * Fix links And reference shorter, newer description of PoH. * Replace ASCII art with SVG * Streamline for Pillbox * Update path before optional install * Use $CARGO_HOME instead of $HOME * Delete code Attempt to describe all data structures without code. * Boot RPU from docs, add JsonRpcService Also, use Rust naming conventions in the block diagrams to minimize the jump from docs to code. * Latest code uses tick_height * Rename bob/ folder to art/ A home for any ASCII art * Import JSON RPC API * More mdbook docs * Add Ncp * Cleanup links * Move pipelining description into fullnode description * Move high-level transaction docs into top-level doc * Delete unused files
2018-11-06 18:00:58 -07:00
## Building the Solana book
Install mdbook:
```bash
cargo install mdbook
```
Run any Rust tests in the markdown:
```bash
mdbook test
```
Render markdown as HTML:
```bash
mdbook build
```
Render and view the book:
```bash
mdbook build --open
```
Reference in New Issue Copy Permalink
Powered by Gitea Version: 1.25.1 Page: 96ms Template: 9ms
English
Bahasa Indonesia Deutsch English Español Français Gaeilge Italiano Latviešu Magyar nyelv Nederlands Polski Português de Portugal Português do Brasil Suomi Svenska Türkçe Čeština Ελληνικά Български Русский Українська فارسی മലയാളം 日本語 简体中文 繁體中文(台灣) 繁體中文(香港) 한국어
Licenses