adds readme content

gh-pages
Moisés Guimarães 2016-04-18 20:47:35 -03:00
parent 532586c503
commit c6fa31d1b9
1 changed files with 28 additions and 0 deletions

View File

@ -0,0 +1,28 @@
wolfcrypt: the wolfSSL crypto engine library
============================================
A Python wrapper which encapsulates the wolfCrypt API inside wolfSSL
** Requires wolfSSL installed **
1. Clone the repository::
$ git clone git@github.com:wolfssl/wolfcrypt-py.git
2. Make sure that ``cffi``, ``py.test``, and ``tox`` are installed::
$ pip install -r requirements-testing.txt
3. Run ``python setup.py install`` to build and install wolfcrypt-py::
$ python setup.py install
...
Finished processing dependencies for wolfcrypt==0.1
4. Test locally with ``tox``::
$ tox
...
_________________________________ summary _________________________________
py27: commands succeeded
congratulations :)