Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aldrik-ramaekers authored Feb 28, 2024
1 parent 89323d8 commit c1e6c79
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# text-search
Text-search is a GUI Program to find files and text within files for Linux. <br>
Text-search is a GUI Program to find files and text within files for x64 Windows and Linux. <br>
text-search is a single and small executable.

https://aldrik.itch.io/text-search
<p float="left">
<img src="https://img.itch.zone/aW1hZ2UvNTQxMDA3LzI4NDM3NDkucG5n/original/JWVbEx.png" width="400">
<img src="https://img.itch.zone/aW1hZ2UvNTQxMDA3LzI4NDM3NDcucG5n/original/8pR%2BhY.png" width="300">
</p>

# Requirements

clone https://github.com/aldrikboy/project-base next to this repo

### Linux
- GCC
- libglu1-mesa-dev, libgl1-mesa-dev, libxrandr-dev (automatically installed with build/install script)
- libglu1-mesa-dev, libgl1-mesa-dev, libxrandr-dev
- ld

## Windows
Expand All @@ -20,7 +22,15 @@ clone https://github.com/aldrikboy/project-base next to this repo

# Build/Install
run __build-linux.sh -r__ or __build-win.bat -r__ for building and running a debug build<br />
run __release-linux.sh__ or __release-windows.bat__ as root to install to __/usr/local/bin/text-search__ or __C:\Users\\\<user>\\Desktop\\text-search.exe__ <br />
run __release-linux.sh__ or __release-windows.bat__ as to building release build<br />

# Deps
All the code required to build is inside the repository.
External libraries used:
- utf8.h https://github.com/sheredom/utf8.h
- stb_truetype.h
- stb_image.h
- cJSON

# Config
config.txt is stored at __~/.config/text-search/config.txt__ or __C:\Users\\\<user>\Local Settings\Application Data\text-search\config.txt__

0 comments on commit c1e6c79

Please sign in to comment.