From 8eac0d25f9369001624ca828adfd133310ca2a3b Mon Sep 17 00:00:00 2001 From: Dan Puttick Date: Wed, 30 Nov 2016 13:53:41 -0500 Subject: [PATCH] Small change to bin/README.md --- bin/README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/bin/README.md b/bin/README.md index d6e60df..03a5569 100644 --- a/bin/README.md +++ b/bin/README.md @@ -1,12 +1,18 @@ +Example scripts +=============== + +These are a series of example scripts designed to demonstrate PyCIRCLean's capabilities. Feel free to +adapt or modify any of them to suit your requirements. In order to use any of these scripts, you will need to +install the PyCIRCLean dependencies (preferably in a virtualenv): + +``` + pip install git+https://github.com/ahupp/python-magic.git # we cannot use the PyPi package for now due to a bug + python setup.py install # from the root of the repository +``` + Requirements per script ======================= -*Note*: in order to use any of those script, you need to install then (in a virtualenv or system wide) - -``` - pip install git+https://github.com/ahupp/python-magic.git # we cannot use the PyPi package for now due to a bug - python setup.py install # from the root of the repository -``` filecheck.py ------------