diff options
| author |  vnugent <public@vaughnnugent.com> | 2024-03-10 16:03:08 -0400 |
|---|---|---|
| committer | vnugent <public@vaughnnugent.com> | 2024-03-10 16:03:08 -0400 |
| commit | dd0f384ec3b2fd86ec03aa0fb42387091b5430a7 (patch) | |
| tree | 23f6e1c99fe2c0d1c0c12b0a40dba2d7f35e90c6 /lib/Utils.Cryptography/monocypher | |
| parent | b679ddd4e647ac915febd0d5a5e488a1e8e48842 (diff) | |
Squashed commit of the following:
commit df1fed9e668d9e629354b209fd9dba18301db5d7
Author: vnugent <public@vaughnnugent.com>
Date: Sun Mar 10 16:01:29 2024 -0400
refactor: primary constructor for HttpRequest
commit 795e7d307b5aa90321f9867d3b6b2630e3d8f29b
Author: vnugent <public@vaughnnugent.com>
Date: Sat Mar 9 16:30:43 2024 -0500
package updates
commit c826c9f99d9ccd43e056bc7b7283146868733e85
Author: vnugent <public@vaughnnugent.com>
Date: Sat Mar 9 14:58:58 2024 -0500
feat: Some docs, and updated clr string erasure functionality
commit cefe2c38d9093bff553aa46c2fcf08380c6e2aed
Author: vnugent <public@vaughnnugent.com>
Date: Wed Mar 6 21:37:59 2024 -0500
chore: removed bad oauth token function, abstracted HttpServer
commit d2ef0e78b27c68fb83d183d50beeeb7a5ba7cba8
Author: vnugent <public@vaughnnugent.com>
Date: Wed Mar 6 19:49:55 2024 -0500
chore: pluginbase logging, consitent proj files, some outdated readmes
commit b7537cd283431f684b16d3008d3b45f8b063d489
Author: vnugent <public@vaughnnugent.com>
Date: Sat Mar 2 15:12:48 2024 -0500
feat: session handle, endpoints, and helper functions
Diffstat (limited to 'lib/Utils.Cryptography/monocypher')
| -rw-r--r-- | lib/Utils.Cryptography/monocypher/readme.md | 30 |
1 files changed, 25 insertions, 5 deletions
diff --git a/lib/Utils.Cryptography/monocypher/readme.md b/lib/Utils.Cryptography/monocypher/readme.md index 940c95f..7c73d80 100644 --- a/lib/Utils.Cryptography/monocypher/readme.md +++ b/lib/Utils.Cryptography/monocypher/readme.md @@ -1,11 +1,12 @@ -# VNLib.Utils.Cryptography -Contains vendored packages that are (optionally)used with VNLib applications such as Argon2 and MonoCypher, as well as build files for compiling the projects cross-platform using CMake and Taskfile.dev. +# vnlib_monocypher +A native shared/dynamic library for transforming exporting Monocypher library functions for use with my .NET managed libraries. A vendored version of Monocypher is included in this directory, that I maintain. -Pre-build Windows binaries are available on my website (link below). + +Pre-built Windows binaries are available on my website (link below). Source code blobs are also packaged and ready for building. See the docs link below for building instructions. ## Builds -Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my website (link below). All tar-gzip (.tgz) files will have an associated checksum and PGP signature of the desired download file. +C libraries are packaged in source code (to compile locally) or Windows amd64 dll binaries and individually packaged source code are available on my website (link below). All tar-gzip (.tgz) files will have an associated checksum and PGP signature of the desired download file. ## Docs and Guides Documentation, specifications, and setup guides are available on my website. @@ -14,4 +15,23 @@ Documentation, specifications, and setup guides are available on my website. [Builds and Source](https://www.vaughnnugent.com/resources/software/modules/VNLib.Core) ## License -Code is individually licensed. See the `LICENSE` file in each subdirectory for more information.
\ No newline at end of file +Code is individually licensed. See the `LICENSE` file in each subdirectory for more information. + +## Notes + +### Building from source +> This guide may become out-of-date, use the docs link above for the most recent information. + +This project uses the [CMake](https://cmake.org) build system for cross-platform compilation. My CMakelist.txt might not be perfect for your platform, so feel free to make a new issue or send me an email if you run into problems compiling on your platform. + +Download the package [source code src.tgz](https://www.vaughnnugent.com/resources/software/modules/VNLib.Core?p=vnlib_monocypher) archive from my builds page. + +```bash +tar -xzf src.tgz +cmake -B./build/ -DCMAKE_BUILD_TYPE=Release +cmake --build ./build/ --config Release +``` + +On **Windows**, you should navigate to build/Release to see your `vnlib_monocypher.dll` file. + +On **Linux**, you should navigate to build/ to see your `libvn_monocypher.so` file.
\ No newline at end of file |