aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMiguel Ángel Moreno <mail@migalmoreno.com>2022-12-31 20:08:47 +0100
committerMiguel Ángel Moreno <mail@migalmoreno.com>2022-12-31 20:08:47 +0100
commit5201e756b09ab80dd696157b2d704058bf718db7 (patch)
tree81f656c8ee6db972d71ced2d332e37eac2df6ea7 /README
parent80bb68bcad8064341120d9c2afda662774216374 (diff)
chore(docs): Add Guix setup notes
Diffstat (limited to 'README')
-rw-r--r--README7
1 files changed, 7 insertions, 0 deletions
diff --git a/README b/README
index d920456..bf7fd6e 100644
--- a/README
+++ b/README
@@ -3,6 +3,13 @@
* Tau
A front-end alternative to various streaming sites. It leverages the excellent [[https://github.com/TeamNewPipe/NewPipeExtractor][NewPipe Extractor]] library that powers the popular [[https://github.com/TeamNewPipe/NewPipe][NewPipe]] Android app. Tau exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
+The easiest way to set up Tau's dependencies is via the [[https://guix.gnu.org/][GNU Guix]] package manager. Simply invoke what follows:
+
+#+begin_src sh
+cd /path/to/tau
+guix shell
+#+end_src
+
To run the application, first compile the downloader ahead-of-time.
#+begin_src sh