From 55254c92e07f4df31941c7af162beee83aa83665 Mon Sep 17 00:00:00 2001 From: Erik N Date: Mon, 29 Jul 2024 22:04:55 +0200 Subject: [PATCH] mdbook --- .gitignore | 1 + README.md | 12 ++++++++++++ book.toml | 6 ++++++ docs/SUMMARY.md | 5 +++++ docs/commands.md | 13 +++++++++++++ docs/intro.md | 3 +++ 6 files changed, 40 insertions(+) create mode 100644 book.toml create mode 100644 docs/SUMMARY.md create mode 100644 docs/commands.md create mode 100644 docs/intro.md diff --git a/.gitignore b/.gitignore index 0592392..2d08354 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ +/book /target .DS_Store diff --git a/README.md b/README.md index f34da34..bbe53e6 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,18 @@ Software Defined Networking +## Documentation + +Serve docs locally from root of local clone of this repo: + +```zsh +cargo install mdbook@0.4.40 +``` + +```zsh +mdbook watch --open +``` + ## git repo URLs - Main repo: https://git.nstr.no/nstr-sw/sdn diff --git a/book.toml b/book.toml new file mode 100644 index 0000000..1e26b6d --- /dev/null +++ b/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Nstr Software AS"] +language = "en" +multilingual = false +src = "docs" +title = "SDN" diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..8fd5218 --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,5 @@ +# Summary + +[Introduction](intro.md) + +- [Commands](commands.md) diff --git a/docs/commands.md b/docs/commands.md new file mode 100644 index 0000000..45c78e7 --- /dev/null +++ b/docs/commands.md @@ -0,0 +1,13 @@ +# Commands + +The following commands are available: + +- [`sdn`](#sdn) + +## sdn + +The main binary is called `sdn`. + +```zsh +cargo run --bin sdn -- +``` diff --git a/docs/intro.md b/docs/intro.md new file mode 100644 index 0000000..45f5cea --- /dev/null +++ b/docs/intro.md @@ -0,0 +1,3 @@ +# Introduction + +Software Defined Networking