# wiki-to-doc

Simple approach to create an offline, distributable copy of a github wiki.

See [the wiki](https://github.com/serra/wiki-to-doc/wiki) for documentation.

[![Build Status](https://travis-ci.org/serra/wiki-to-doc.svg?branch=master)](https://travis-ci.org/serra/wiki-to-doc)

## Developing

Developed using Python 3.4.

Assuming virtualenve 1.7+:

```
cd [wiki-to-doc repo]
virtualenv -p /usr/bin/python3.4 venv
source venv/bin/activate
pip install -r requirements.txt
```


## Installing


## Usage


# wiki-to-doc

Simple approach to create an offline, distributable copy of a github wiki.

See [the wiki](https://github.com/serra/wiki-to-doc/wiki) for documentation.

[![Build Status](https://travis-ci.org/serra/wiki-to-doc.svg?branch=master)](https://travis-ci.org/serra/wiki-to-doc)

## Developing

Developed using Python 3.4.

Assuming virtualenv 1.7+:

```
cd [wiki-to-doc repo]
virtualenv -p /usr/bin/python3.4 venv
source venv/bin/activate
pip install -r requirements.txt
```

Run tests:

```
cd [wiki-to-doc repo]
pytest
```

## Installing


## Usage


Add note on running test
Add note on running test
