diff --git a/README.md b/README.md index 5752c0d..4e46e3e 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,16 @@ PyCIRCLean is the core Python code used by [CIRCLean](https://github.com/CIRCL/Circlean/), an open-source USB key and document sanitizer created by [CIRCL](https://www.circl.lu/). This module has been separated from the device-specific scripts and can be used for dedicated security applications to sanitize documents from hostile environments -to trusted environments. PyCIRCLean is currently Python 3.3+ compatible. Also, while [kittengroomer](./kittengroomer) can +to trusted environments. PyCIRCLean is currently Python 3.6+ compatible. Also, while [kittengroomer](./kittengroomer) can run on any platform supported by python-magic/libmagic, [filecheck.py](./filecheck/filecheck.py) has some dependencies that are Linux-only, and running the full test suite will require access to a Linux box or VM. # Installation ~~~ -python setup.py install -~~~ - -OR - -~~~ -pip install . +git clone https://github.com/CIRCL/PyCIRCLean.git +cd PyCIRCLean +pip3 install -e . ~~~ # How to use PyCIRCLean