From 260f05025631031b7cc4904805d5017feaf53eda Mon Sep 17 00:00:00 2001
From: Aldrik Ramaekers <aldrik.ramaekers@protonmail.com>
Date: Thu, 30 Jan 2020 21:11:12 +0100
Subject: initial commit

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e08cbc4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# text-search
+Text-search is a GUI Program to find files and text within files for Linux. <br>
+text-search is a single and small executable.
+
+# Requirements
+
+### Linux
+- GCC
+- libglu1-mesa-dev, libgl1-mesa-dev (automatically installed with build/install script)
+- ld
+
+## Windows (not working)
+- MinGW32
+- Windres
+- ld
+
+# Build/Install
+run __build-linux.sh -r__ or __build-win.sh -r__ for building and running a debug build<br />
+run __install.sh__ as root to install to __/usr/local/bin/text-search__ or __C:\Users\\\<user>\\Desktop\\text-search.exe__ <br />
+
+# Config
+config.txt is stored at __~/.config/text-search/config.txt__ or __C:\Users\\\<user>\Local Settings\Application Data\text-search\config.txt__
-- 
cgit v1.2.3-70-g09d2