aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..31e928d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# OmniSearch
+
+A modern lightweight metasearch engine with a clean design written in C. [You can try using it here!](https://search.bwaaa.monster/)
+
+## Configuration
+edit src/Config.h
+
+## Dependencies
+- libxml2
+- libcurl
+- beaker [(source)](https://git.bwaaa.monster/beaker/)
+
+## Running
+```bash
+git clone https://git.bwaaa.monster/omnisearch/
+cd omnisearch
+make run
+``` \ No newline at end of file