aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 27 insertions, 3 deletions
diff --git a/README.md b/README.md
index 2ad2d87..5643b19 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,38 @@
# hardflip
-The best TUI tool to connect to your distant hosts.
+The best TUI tool to connect to your distant hosts. For Linux/BSD. Might work
+on macOS.
## Dependencies
-Install those if you need them :
+Install those if you need them:
+ `sshpass` if you are using passwords with SSH (honnestly use keys instead)
+ `xfreerdp` for RDP. Called `freerdp2-x11` on some distros
+ `openstack` for OpenStack CLI.
+ `gpg` to crypt passwords. You can store them in plain text if you prefer but
-i wouldn't recommend that option.
+I wouldn't recommend that option.
+ `go`
++ GNU `make`
+
+## Install
+
+To install `hardflip`, run those commands in your shell:
+
+```sh
+git clone git://gitjoe.xyz/jozan/hardflip
+cd hardflip
+make
+sudo make install
+make clean
+```
+
+Change this line:
+
+```make
+DEST := /usr
+```
+
+if you want to install stuff some other place
+
+## Config