An open API service indexing awesome lists of open source software.

https://github.com/rdmorganiser/rdmo-docs

English documentation for rdmo
https://github.com/rdmorganiser/rdmo-docs

Last synced: 5 months ago
JSON representation

English documentation for rdmo

Awesome Lists containing this project

README

          

# RDMO - Research Data Management Organiser

[![Latest release](https://img.shields.io/pypi/v/rdmo.svg?style=flat)](https://pypi.python.org/pypi/rdmo/)
[![License](https://img.shields.io/github/license/rdmorganiser/rdmo?style=flat)](https://github.com/rdmorganiser/rdmo/blob/master/LICENSE)
[![Documentation status](https://readthedocs.org/projects/rdmo/badge/?version=latest)](http://rdmo.readthedocs.io/en/latest/?badge=latest)

RDMO is a tool to support the systematic planning, organisation and implementation of the data management throughout the course of a research project. RDMO is funded by the Deutsche Forschungsgemeinschaft (DFG).

## English documentation

### Setup

First install requirements (e.g. `sphinx`):

```bash
python -m pip install -r requirements.txt
```

Then, the HTML files can be created using:

```bash
make html
```

A live server, which auto-updates itself after a file is saved, can be started using:

```bash
make live
```

The documentation is then available on http://localhost:8001.