Add mdBook skeleton (#640)

This commit is contained in:
Youngjoon Lee 2024-04-24 23:18:51 +09:00 committed by GitHub
parent cddd215025
commit e904793b7e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 63 additions and 0 deletions

1
book/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
book

6
book/README.md Normal file
View File

@ -0,0 +1,6 @@
# Nomos Node Book
To build the book and view it in your browser, run the following command:
```bash
mdbook serve --open
```

6
book/book.toml Normal file
View File

@ -0,0 +1,6 @@
[book]
authors = []
language = "en"
multilingual = false
src = "src"
title = "Nomos Node"

7
book/src/SUMMARY.md Normal file
View File

@ -0,0 +1,7 @@
# Summary
- [Introduction](./introduction.md)
- [Installation](./installation/installation.md)
- [Docker image](./installation/docker.md)
- [Building from source](./installation/source.md)
- [Run Nodes](./run-nodes.md)

View File

@ -0,0 +1,22 @@
# Installation using Docker
## Building the Docker image
To build the Docker image, run the following command at the root of the project:
```bash
docker build -t nomos .
```
## Using the Docker image
You can run a Nomos node using the Docker image by running the following command:
```bash
docker run nomos /etc/nomos/config.yml
```
To run a node with a different configuration run:
```bash
docker run -v /path/to/config.yml:/etc/nomos/config.yml nomos /etc/nomos/config.yml
```
For more detailed instructions to configure and run Nomos nodes, refer to the [Run Nodes](../run-nodes.md).

View File

@ -0,0 +1,7 @@
# Installation
Nomos Node runs on Linux, macOS, and Windows.
There are several ways to install Nomos Node:
- [Docker image](./docker.md)
- [Building from source](./source.md)

View File

@ -0,0 +1 @@
# Building from source

1
book/src/introduction.md Normal file
View File

@ -0,0 +1 @@
# Nomos Node

11
book/src/run-nodes.md Normal file
View File

@ -0,0 +1,11 @@
# Run Nomos Nodes
This section provides instructions to configure and run multiple Nomos nodes.
You should read with the [Installation](../installation/installation.md) section before proceeding.
## Configuration
A Nomos node is configured using a configuration file (YAML).
If you are running a node using the Docker image, the config file is contained in the image (`/etc/nomos/config.yml`).
TODO

View File

@ -0,0 +1 @@
# Run Nodes