aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README3
-rw-r--r--REQUIREMENTS28
2 files changed, 31 insertions, 0 deletions
diff --git a/README b/README
index e2568ea..4b02cca 100644
--- a/README
+++ b/README
@@ -81,6 +81,9 @@ cd arching-kaos-tools
If you encounter any errors, please open an issue.
+For more extended description on the installation process, refer to `INSTALL`
+file.
+
Update
------
diff --git a/REQUIREMENTS b/REQUIREMENTS
new file mode 100644
index 0000000..e551afb
--- /dev/null
+++ b/REQUIREMENTS
@@ -0,0 +1,28 @@
+Requirements
+------------
+
+Even though there is a brief description of them in the README file, this space
+would be more convenient to mention these.
+
+To run this repository with no errors from missing depedencies you will need at
+least the following:
+
+bash
+gpg
+jq
+node
+npm
+npx
+make
+curl
+wget
+screen
+
+Note that some of those are checked if they already exist in your system during
+installation and if not found there is an attempt to install them.
+
+IPFS command line tool is also needed but is installed as well during the
+installation process.
+
+CJDNS can be used as a peering method. ak-cjdns-scanner can be used to retrieve
+them. This requires CJDNS to be running and `dumpLinks` tool to be in your PATH.