license, readme

README.md

@@ -0,0 +1,28 @@
+# gwrizienn
+
+Modular arithmetic, polynomial quotient rings in Rust.
+
+Early development, really.
+
+Goals:
+* Easy to use, obvious when you look at the documentation and type system
+* Fast, most possible work is done at compile time
+* All the math you need for implementing cryptographic schemes such as Dilithium
+
+Non-goals:
+* Generic (it's generic but only for primitive types)
+* Complete (it's simple because it's not a complete implementation of modern algebra)
+
+## Name
+
+It's Breton for "root", because we use roots of unity to compute the NTT for faster polynomial multiplication.
+
+## License
+
+[Support me via LiberaPay](https://liberapay.com/tuxmain/donate)
+
+GNU AGPL v3, CopyLeft 2025 Pascal Engélibert [(why copyleft?)](https://txmn.tk/blog/why-copyleft/)
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.  
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.  
+You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.