aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan200101 <sentrycraft123@gmail.com>2022-06-13 20:36:07 +0200
committerJan200101 <sentrycraft123@gmail.com>2022-06-13 20:36:07 +0200
commit1d87853d31ef23c3ad12610190b9be8520f48025 (patch)
treecc34011f7ee4745792167cba07d0edf9156fa486
parent3a235f034652dcba5e5fbf9473276ca8475f46a3 (diff)
downloadOFQT-1d87853d31ef23c3ad12610190b9be8520f48025.tar.gz
OFQT-1d87853d31ef23c3ad12610190b9be8520f48025.zip
add README
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..31aa2d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# OFQT
+
+## What is this?
+OFQT is a library and a set of frontends for downloading OpenFortress.
+
+In its entirety OFQT is made up of:
+- libtvn
+ a C library that deals revision information, downloading storing, applying, verifying, etc.
+
+- OFCL
+ a commandline client for libtvn
+
+- OFQT
+ a GUI for libtvn written in Qt
+
+and possibly more in the future
+
+## Supported Systems
+All Systems OpenFortress supports
+
+## Dependencies
+### libtvn
+- libcurl
+- json-c
+
+### OFQT
+- Qt 5
+
+### [License](LICENSE)
+
+OFQT is licensed under the GPLv3