README.md

ABSA Subatomic User Documentation

Go to the ABSA Subatomic User Documentation

Getting Started

This project uses MkDocs. MkDocs is a fast, simple static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

1. Install Python 3 on your machine.
2. Setup a Python virtual environment.
3. Navigate to the root of this project and install the dependencies using pip as follows:

$ pip install -r requirements.txt

Once the dependencies are installed, you can start a local server to view the docs:

$ mkdocs serve