Create README.md

This commit is contained in:
Evan Su 2021-03-15 15:12:30 -04:00 committed by GitHub
parent 3576cb857e
commit e53390f88e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

1
src/README.md Normal file
View file

@ -0,0 +1 @@
Note: Picocrypt can use the <code>reedsolo</code> by itself, but it is very slow because it's pure Python. It is recommended to compile a Python extension (.pyd/.so) for <code>reedsolo</code>, and name it creedsolo (ie. <code>creedsolo.pyd</code> or <code>creedsolo.so</code>). 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.