summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndreas Fankhauser hiddenalpha.ch2024-04-23 23:09:38 +0200
committerAndreas Fankhauser hiddenalpha.ch2024-04-23 23:09:38 +0200
commit1c837a1ef1615e80220857f31312d3f3135c2446 (patch)
tree78fa30fe201f3babb03acb72b587e6ff6eea502c /README.md
parent97850a976c5412d368b3584b885bcdb3ea8bb50c (diff)
downloadgetaddrinfo-cli-1c837a1ef1615e80220857f31312d3f3135c2446.zip
getaddrinfo-cli-1c837a1ef1615e80220857f31312d3f3135c2446.tar.gz
Add doc to readme how to build.v0.0.2
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b89f304
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+
+getaddrinfo-cli
+===============
+
+Simple commandline frontend for [getaddrinfo](https://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html).
+
+[Home](https://git.hiddenalpha.ch/getaddrinfo-cli.git/tree/README.txt).
+
+[Downloads](https://github.com/hiddenalpha/getaddrinfo-cli/releases).
+
+
+
+## Build/Install From Source
+
+Make sure you have at least:
+- C compiler
+- libc
+- make
+
+Then take a look if you need to tune anything in the Makefile.
+
+Then to build do:
+```sh
+make clean
+make
+```
+
+And to install:
+```sh
+make install
+```
+
+Or install even simpler:
+```sh
+tar -C /usr/local -xzf path/to/dist/your-build.tgz -- bin
+```
+