From be17661d989252da578457ed2ce87d9adab12404 Mon Sep 17 00:00:00 2001 From: Joaquin Iglesias Turina Date: Thu, 8 Feb 2024 22:18:40 +0100 Subject: [PATCH] updated readme --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ README.org | 10 ++++++++++ 2 files changed, 48 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4506fe3 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ + +# Table of Contents + +1. [Assumptions](#orgd739325) +2. [Main concepts to understand](#org37e0e51) +3. [Install depencencies](#org14668e5) +4. [Run code](#org543ab5e) + + + + +# Assumptions + +`fennel` and `guix` should be installed. + + + + +# Main concepts to understand + +- Packages +- Channels +- Profiles + + + + +# Install depencencies + + guix install lume faith -L../fennel-channel --profile=./deps + + + + +# Run code + + fennel test-loader.fnl + diff --git a/README.org b/README.org index 03477c6..a727d92 100644 --- a/README.org +++ b/README.org @@ -1,3 +1,6 @@ +* Assumptions +=fennel= and =guix= should be installed. + * Main concepts to understand - Packages - Channels @@ -7,3 +10,10 @@ #+begin_src bash guix install lume faith -L../fennel-channel --profile=./deps #+end_src + +* Run code +#+begin_src bash + fennel test-loader.fnl +#+end_src + + -- 2.45.2