add README.md

README.md

@@ -1,4 +1,31 @@
-# sleuth
+String Search - Qt applications
+====================================================
+Description
+-----------
+Created an analogue of GREP and directory indexing tools with UI for 
+finding string occurences in the selected folder
 
-Recursively indexes all files in folder and reindexes when files 
-changing with the ability to search for string in these files
+Completed feature for automatically rebuilding indexes when file is changed
+
+Install Qt 5 on Ubuntu
+---------------------
+Open a terminal. Type the following command and hit Enter:
+```bash
+sudo apt-get install qt5-default
+```
+
+Run application
+----------------------
+Open a terminal. Type the following command and hit Enter:
+Steps:
+```bash
+git clone https://github.com/ShSamariddin/StringSearch.git
+cd StringSearch
+chmod u+x linux.sh
+./linux.sh
+```
+## Preview
+![preview.gif](https://i.loli.net/2020/09/16/Jrv5iVZK8PshQpe.gif)
+
+### Screenshot
+<img src="https://i.loli.net/2020/09/16/raL86U32ljuDsn4.png" alt="PrSubtitle" width="650" />