From 64fbf3622678b6d7e960ca25b850cd66cd508ea4 Mon Sep 17 00:00:00 2001
From: cosmonaut <evan@moonside.games>
Date: Tue, 12 Apr 2022 20:00:50 -0700
Subject: [PATCH] description

---
 LICENSE              | 23 +++++++++++++++++++++++
 README.md            | 25 +++++++++++++++++++++++++
 include/Wellspring.h |  2 +-
 src/Wellspring.c     |  2 +-
 4 files changed, 50 insertions(+), 2 deletions(-)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..c266b47
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,23 @@
+Wellspring - A very simple font rendering system
+
+Copyright (c) 2022 Evan Hemsley
+
+This software is provided 'as-is', without any express or implied warranty.
+In no event will the authors be held liable for any damages arising from
+the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+claim that you wrote the original software. If you use this software in a
+product, an acknowledgment in the product documentation would be
+appreciated but is not required.
+
+2. Altered source versions must be plainly marked as such, and must not be
+misrepresented as being the original software.
+
+3. This notice may not be removed or altered from any source distribution.
+
+Evan "cosmonaut" Hemsley <evan@moonside.games>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e230af3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+This is Wellspring, an immediate mode font rendering system in C.
+
+About Wellspring
+----------------
+Wellspring is inspired by the design of Dear ImGui.
+It outputs pixel data that you can upload to a texture and vertex buffers that you can render anytime in your 3D application.
+This means that you can integrate it easily using the graphics library of your choice.
+Wellspring uses stb_truetype to rasterize and pack fonts quickly.
+
+Dependencies
+------------
+Wellspring depends on the C runtime, but SDL2 can be optionally depended upon instead if your application prefers it.
+
+Building Wellspring
+-------------------
+For *nix platforms, use Cmake:
+
+	$ mkdir build/
+	$ cd build
+	$ cmake ../
+	$ make
+
+License
+-------
+Wellspring is licensed under the zlib license. See LICENSE for details.
diff --git a/include/Wellspring.h b/include/Wellspring.h
index c622572..bcd01ed 100644
--- a/include/Wellspring.h
+++ b/include/Wellspring.h
@@ -1,4 +1,4 @@
-/* Wellspring - A very simple font rendering system
+/* Wellspring - An immediate mode font rendering system in C
  *
  * Copyright (c) 2022 Evan Hemsley
  *
diff --git a/src/Wellspring.c b/src/Wellspring.c
index d9cf070..48feeb2 100644
--- a/src/Wellspring.c
+++ b/src/Wellspring.c
@@ -1,4 +1,4 @@
-/* Wellspring - A very simple font rendering system
+/* Wellspring - An immediate mode font rendering system in C
  *
  * Copyright (c) 2022 Evan Hemsley
  *