diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000000..7585238efe --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +book diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000..8e379b7b28 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,13 @@ +# LibAFL Documentation + +This project contains the out-of-source LibAFL documentation. + +Here you can find tutorials, examples and detailed explanations. + +For the API documentation instead, run `cargo doc` in the LibAFl root folder. + +## Usage + +To build this book, you need [mdBook](https://github.com/rust-lang/mdBook). + +`mdbook build` to build, `mdbook serve` to serve the book locally. diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000000..68f4a19788 --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Andrea Fioraldi"] +language = "en" +multilingual = false +src = "src" +title = "LibAFL Documentation" diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md new file mode 100644 index 0000000000..7390c82896 --- /dev/null +++ b/docs/src/SUMMARY.md @@ -0,0 +1,3 @@ +# Summary + +- [Chapter 1](./chapter_1.md) diff --git a/docs/src/chapter_1.md b/docs/src/chapter_1.md new file mode 100644 index 0000000000..b743fda354 --- /dev/null +++ b/docs/src/chapter_1.md @@ -0,0 +1 @@ +# Chapter 1