README.md

[Project Name]

project description

[Project Name] is a library implementing time-travel equations based on incomplete scarce agile data. This project is used to build flux capacitors. More information about this project can be found in my third book.

Download

Pre requirements

[Project Name] requires a previous installation of radioactive filters in your machine. You can do it on linux by executing

sudo apt-get radioactive-filters

or in mac and windows by following the instructions on this webpage: http://cool.radioactive.filters

Install using pip

You can find this package in the Python package index and install it using pip

pip install [project_name]

Install from sources

Clone this repository

git clone https://github.com/[myself]/[project_name].git
cd [project_name]

And execute setup.py

pip install .

Of course, if you're in development mode and you want to install also dev packages, documentation and/or tests, you can do as follows:

pip install -e .

Usage examples

You can import [my package] by doing

import my_package as mp

The main functions included in this package are x() and z(). x receives A as argument and does X. Here is example of its usage:

x(`hello`, `world`, 27, [])

A more detailed documentation can be found in [link].