From 44dff1745d2c5952fb947d13e26b0177bdd6221a Mon Sep 17 00:00:00 2001 From: Dan Guido Date: Mon, 24 Apr 2017 17:24:29 -0400 Subject: [PATCH] Add readthedocs (#179) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add readthedocs badge * Add rtd intro * Add API reference link * change the order wiki first, because that’s where the majority of the docs live --- README.md | 3 ++- docs/index.rst | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3b0f944..b1ff540 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![Build Status](https://travis-ci.com/trailofbits/manticore.svg?token=m4YsYkGcyttTxRXGVHMr&branch=master)](https://travis-ci.com/trailofbits/manticore) [![Slack Status](https://empireslacking.herokuapp.com/badge.svg)](https://empireslacking.herokuapp.com) +[![Documentation Status](https://readthedocs.org/projects/manticore/badge/?version=latest)](http://manticore.readthedocs.io/en/latest/?badge=latest) [![Bountysource](https://img.shields.io/bountysource/team/trailofbits/activity.svg)](https://www.bountysource.com/teams/trailofbits) Manticore is a prototyping tool for dynamic binary analysis, with support for symbolic execution, taint analysis, and binary instrumentation. @@ -132,4 +133,4 @@ def hook(state): m.run() ``` -See the [examples](examples) directory and the [wiki](https://github.com/trailofbits/manticore/wiki) for further documentation and examples. +See the [wiki](https://github.com/trailofbits/manticore/wiki), [examples](examples) directory, and [API reference](http://manticore.readthedocs.io/en/latest/) for further documentation. diff --git a/docs/index.rst b/docs/index.rst index 4109a3c..bca7d4a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ Welcome to Manticore's documentation! ===================================== -This is the documentation for the Manticore project. +Manticore is a prototyping tool for dynamic binary analysis, with support for symbolic execution, taint analysis, and binary instrumentation. .. toctree:: :maxdepth: 2