From b110a70975196dfbcb06361641487c52b4e90014 Mon Sep 17 00:00:00 2001 From: Chad Smith Date: Sat, 27 Apr 2019 07:40:58 -0700 Subject: [PATCH] add system requirements section #33 Documentation to successfully build wheels on Ubuntu for httptools --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 47ea9ea..368c472 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,23 @@ httptools is a Python binding for nodejs HTTP parser. It's still in a very early development stage, expect APIs to break. -The package is available on PyPI: `pip install httptools`. +# Installation +The package is available on PyPI: +``` +pip install httptools +``` + +## System Requirements + +### Ubuntu +`python-dev` must be installed for your version of Python. If you are using Python3.7, run: +``` +sudo apt install python3.7-dev +``` + +### macOS +Coming soon # APIs