From a4fd4d70557a43f05007cf178626ee86294c8d6a Mon Sep 17 00:00:00 2001 From: Alexey Yerin Date: Sun, 17 Jan 2021 23:49:27 +0300 Subject: [PATCH] Add installation instructions --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 026394c..30a2100 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,31 @@ # gtranslate Better front-end for Google Translate that doesn't track you and works without JavaScript. + +# Installation +```sh +git clone https://git.sr.ht/~yerinalexey/gtranslate +cd gtranslate + +go build +``` + +Then run the server with + +```sh +./gtranslate +``` + +If you want to use a different port: + +```sh +./gtranslate -b :3000 # will run on port 3000 +``` + +Note: if you're running it outside of development environment, you +should pass `--template-dir` and `--static-dir` arguments pointing to +templates and static directories: + +```sh +./gtranslate --template-dir /usr/share/webapps/gtranslate/templates --static-dir /usr/share/webapps/gtranslate/static +```