README

Mediawiki Flow Parser
========================================

Convert a Mediawiki Flow to a terminal flow. (Readable by bots or humans)
API_PATH is the directory path of API.

Installation instructions
-------------------------

1. Install the cURL library

    $ cd API_PATH/curl
    $ ./configure
    $ make
    $ sudo make install

2. Install the jansson library

    $ cd API_PATH/jansson
    $ ./configure
    $ make
    $ sudo make install

3. Start the API

    $ cd API_PATH
    $ make
    $ ./flow_parser [-H]

    -H argument increase human readability.

4. Use of API

    flow-parser> Type "view-topiclist URL" to get the list of topics at URL.
    		 Get next topics by retype this command.
    flow-parser> Type "view-topic TOPIC_NUMBER" to get the topic.
    flow-parser> Type "exit" to exit the API.

Other
-----

The mediawiki flow page: http://www.mediawiki.org/wiki/Flow
This project is under MIT License see LICENSE file for more details.