diff --git a/src/README.md b/src/README.md index 79679fb..e16ae12 100644 --- a/src/README.md +++ b/src/README.md @@ -1,11 +1,11 @@ # Instructions -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 any issues. If Picocrypt can't automatically install dependencies, install these dependencies via pip manually: argon2-cffi, pycryptodome, and reedsolo. +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 will usually work without any issues. If Picocrypt can't automatically install dependencies, install these dependencies via pip manually: argon2-cffi, pycryptodome, and reedsolo. # A note about reedsolo -Picocrypt can use the raw reedsolo pip package by 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 extensively, or if you are okay with speeds ~1MB/s. +Picocrypt can use the raw reedsolo pip package by 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 or MacOS, 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 extensively, or if you are okay with speeds ~1MB/s. Picocrypt will work just fine without the entension and just the way it is. # External links -Here are the Github links of the dependencies of Picocrypt: +Here are the Github links of the dependencies of Picocrypt, if you are curious or want to audit them: