diff --git a/README.md b/README.md index caa8d56..55ea97e 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,43 @@ # fremen-transcriptor -Sofware to transcript ASCII into desert people's writing from popular sci-fi franchise. +Software to transcript ASCII into desert people's writing from popular sci-fi franchise. -## Quick start: +## Quick start: -### Linux +### Linux & Windows: +- Download the zip file from [Releases tab](https://github.com/theKapcioszek/fremen-transcriptor/releases) for your respectible system +- Extract the zip file +- Run the fremen-transcriptor executable +- enjoy :) +- Press **f2** to take a screenshot and **f3** to capture only generated text +- Press **Select** button in GUI window to select a directory and save your screenshot -if you want to pass phrase as an argument: +Also available as an **AUR Package** for Arch Linux: +[https://aur.archlinux.org/packages/fremen-transcriptor-git](https://aur.archlinux.org/packages/fremen-transcriptor-git) + +## Building: + +### Linux: ```console -make -./fremen +$ make +$ ./fremen # To run it +$ sudo make install # To install it ``` -if you want to input text in real time: - +### Windows: +The Makefile I made is not really suited for Windows, +but you can compile it on Linux using mingw and run it with wine if you want ```console -make -./fremen +$ make fremen.exe # Requires mingw +$ wine fremen.exe # To run it ``` - -Also available as an **AUR Package**: -[https://aur.archlinux.org/packages/fremen-transcriptor-git](https://aur.archlinux.org/packages/fremen-transcriptor-git) - -### Windows - -Download the zip from releases (Currently only x86_64 supported) - -Press **f2** to take a screenshot and **f3** to capture only generated text +If you want to compile this project on Windows you have to look into it yourself. +If you do you can also submit a pull request :) ## TODO: - [X] Add text box instead of passing an argument - [X] Option to save result as an image +- [ ] Add numbers