From b7ed042f0e28c7d126fb7e889caf216c5fd3c03e Mon Sep 17 00:00:00 2001 From: Evan Su <48808396+HACKERALERT@users.noreply.github.com> Date: Mon, 15 Mar 2021 15:15:39 -0400 Subject: [PATCH] Update README.md --- src/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/README.md b/src/README.md index 2ce8749..629b79a 100644 --- a/src/README.md +++ b/src/README.md @@ -1 +1,5 @@ -Note: Picocrypt can use the reedsolo pip package itself, but it is very slow because it's pure Python. It is recommended to compile a Python extension (.pyd/.so) for reedsolo, and name it creedsolo (ie. creedsolo.pyd or creedsolo.so). Make sure to include the extension in the same directory as Picocrypt.py. The Windows executable already bundles creedsolo.pyd, but for Linux, you'll have to build the Python extension yourself if you want better speeds. Building the extension is not necessary if you don't intend on using the Reed-Solomon feature, or if you are okay with speeds ~1MB. +# Usage +Picocrypt is written to be cross-platform, so you should be able to run the raw Python file on your OS without any issues. Picocrypt's dependencies will be automatically installed via pip, which should work without issue. + +# Note +Picocrypt can use the reedsolo pip package itself, but it is very slow because it's pure Python. It is recommended to compile a Python extension (.pyd/.so) for reedsolo, and name it creedsolo (ie. creedsolo.pyd or creedsolo.so). Make sure to include the extension in the same directory as Picocrypt.py. The Windows executable already bundles creedsolo.pyd, but for Linux, you'll have to build the Python extension yourself if you want better speeds. Building the extension is not necessary if you don't intend on using the Reed-Solomon feature, or if you are okay with speeds ~1MB.