docs folder

This commit is contained in:
Andrea Fioraldi 2021-03-22 20:22:42 +01:00
parent 61a89f4aa6
commit 009c35dbf9
5 changed files with 24 additions and 0 deletions

1
docs/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
book

13
docs/README.md Normal file
View File

@ -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.

6
docs/book.toml Normal file
View File

@ -0,0 +1,6 @@
[book]
authors = ["Andrea Fioraldi"]
language = "en"
multilingual = false
src = "src"
title = "LibAFL Documentation"

3
docs/src/SUMMARY.md Normal file
View File

@ -0,0 +1,3 @@
# Summary
- [Chapter 1](./chapter_1.md)

1
docs/src/chapter_1.md Normal file
View File

@ -0,0 +1 @@
# Chapter 1