]> git.seodisparate.com - UDPConnection/commitdiff
Add LICENSE and README.md
authorStephen Seo <seo.disparate@gmail.com>
Mon, 13 Jan 2020 09:40:14 +0000 (18:40 +0900)
committerStephen Seo <seo.disparate@gmail.com>
Mon, 13 Jan 2020 09:41:38 +0000 (18:41 +0900)
LICENSE [new file with mode: 0644]
README.md [new file with mode: 0644]

diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..8a8e0b2
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-2020 Stephen Seo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..1400d75
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# UDPConnection
+
+Provides a network connection over UDP, with verification of packet support via
+libsodium (optional). Implemented in C++, but is available via a C api, which
+should facilitate creating bindings for other programming languages if needed.
+
+This library is still a work in progress, so api breaking changes may happen
+in the future.
+
+## Compiling
+
+    mkdir buildRelease
+    cd buildRelease
+    cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr -DBUILD_SHARED_LIBS=True ..
+    make
+    make DESTDIR=install_destination install