From 41407c3659a7d9b05688e07ffa153a0340cc6239 Mon Sep 17 00:00:00 2001 From: Joel Franusic Date: Fri, 5 Jun 2015 13:08:53 -0700 Subject: [PATCH] Update README with development libraries. --- README.md | 19 +++++++++++++++++++ README.org | 19 +++++++++++++++++++ 2 files changed, 38 insertions(+) diff --git a/README.md b/README.md index a876daa..6b1413c 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,25 @@ This is an example SAML SP service written using [Flask](http://flask.pocoo.org/ - [Virtualenv](https://virtualenv.pypa.io/en/latest/) - [pip](https://pip.pypa.io/en/stable/) +You will also need a development environment capable of compiling +Python packages and the "libffi" and "libxmlsec1" development +libraries, which are needed by PySAML2. + +Instructions for installing these development libraries will differ +depending on your host operating system. + +## Mac OS X + +```shell +$ brew install libffi libxmlsec1 +``` + +## RHEL + +```shell +$ sudo yum install libffi-devel xmlsec1 xmlsec1-openssl +``` + # Installation ```shell diff --git a/README.org b/README.org index 80406dc..6cd8922 100644 --- a/README.org +++ b/README.org @@ -14,6 +14,25 @@ - [[https://www.python.org/][Python]] 2.7+ - [[https://virtualenv.pypa.io/en/latest/][Virtualenv]] - [[https://pip.pypa.io/en/stable/][pip]] + + You will also need a development environment capable of compiling + Python packages and the "libffi" and "libxmlsec1" development + libraries, which are needed by PySAML2. + + Instructions for installing these development libraries will differ + depending on your host operating system. +** Mac OS X + #+BEGIN_HTML + ```shell + $ brew install libffi libxmlsec1 + ``` + #+END_HTML +** RHEL + #+BEGIN_HTML + ```shell + $ sudo yum install libffi-devel xmlsec1 xmlsec1-openssl + ``` + #+END_HTML * Installation #+BEGIN_HTML ```shell