From e53390f88e43cd3b061461cf6698b8bb1984b04a Mon Sep 17 00:00:00 2001
From: Evan Su <48808396+HACKERALERT@users.noreply.github.com>
Date: Mon, 15 Mar 2021 15:12:30 -0400
Subject: [PATCH] Create README.md
---
src/README.md | 1 +
1 file changed, 1 insertion(+)
create mode 100644 src/README.md
diff --git a/src/README.md b/src/README.md
new file mode 100644
index 0000000..21cc263
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1 @@
+Note: Picocrypt can use the reedsolo
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
). 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.