mirror of https://github.com/google/oss-fuzz.git
d70f793353
* style: Clean up the repo * Bolster the `.gitignore` * Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80 characters and seperate links for readability * Remove pesky Unicode dash in `CONTRIBUTING.md` * Remove `.DS_STORE` files * Rename `#project.yaml#` to something logical and enable stntax highlighting * Updates from reviewers * Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim temporary files * Apply markdown style to `docs/index.md` * small comma grammatical change * http -> https |
||
---|---|---|
.. | ||
advanced-topics | ||
further-reading | ||
getting-started | ||
images | ||
oss-fuzz | ||
reference | ||
.gitignore | ||
404.html | ||
Gemfile | ||
Gemfile.lock | ||
README.md | ||
_config.yml | ||
faq.md | ||
favicon.ico | ||
glossary.md | ||
ideal_integration.md | ||
index.md | ||
new_project_guide.md | ||
reproducing.md |
README.md
Readme
Use the following instructions to make documentation changes locally.
Prerequisites
$ sudo apt install ruby bundler
$ bundle install --path vendor/bundle
Serving locally
$ bundle exec jekyll serve
Theme documentation
We are using the just the docs theme.