From c9ff548e68dee786f09212df75a7aeb835f47af9 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Nov 01 2015 21:35:28 +0000 Subject: Add some instructionson how to get the project running --- diff --git a/README.rst b/README.rst index 89fc4be..3e1504b 100644 --- a/README.rst +++ b/README.rst @@ -4,3 +4,41 @@ MDAPI mdapi (for metadata API) is a simple API aiming at providing as fast as possible the information contained in the metadata files generated for RPM repositories. + +Development +----------- + +If you wish to set-up this project. + +* Install virtualenvwrapper + +:: + + dnf install python-virtualenvwrapper + +* Create the virtualenv + +:: + + mkvirtualenv mdapi + +* Install the dependencies + +:: + + pip install -r requirements.txt + +* Download the metadata + +:: + + mdapi-get_repo_md mdapi/default_config.py + +* Start the server + +:: + + ./mdapi-run + + +..note: This project is python3 only