From b58ad53506d74f5efec07f900219b12466bf531c Mon Sep 17 00:00:00 2001 From: Chris Cochrun Date: Tue, 6 Dec 2022 12:52:46 -0600 Subject: [PATCH] updating awesome readme.org --- awesome/README.org | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/awesome/README.org b/awesome/README.org index 1822314..2d961fc 100644 --- a/awesome/README.org +++ b/awesome/README.org @@ -3,3 +3,40 @@ #+DESCRIPTION: This Awesome Window Manager config is written primarily in fennel. This is a lisp written in and compiled to lua. Fennel runs at lua speeds but is created to make a lisp syntax for lua and to provide a lisp macro system for lua. I prefer reading and writing lisps over lua so that is why my AwesomeWM is configured in fennel. To get us started we need to bootstrap fennel in order to get Awesome to load .fnl files. + +To do that, ensure that fennel is installed. +#+begin_src bash +pacman -Syu fennel +#+end_src + +Then use this for you're rc.lua + +#+begin_src lua +fennel = require("fennel") +local gears = require("gears") +local naughty = require("naughty") +cfgDir = os.getenv("HOME") .. "/.config/awesome/" +-- package.path = cfgDir .. "?.lua" +fennel.path = fennel.path .. ";" .. cfgDir .. "?.fnl;" + + +-- naughty.notification{ title = "YAY RC LOADED"} + +searcher = fennel.make_searcher({ + correlate = true, + useMetadata = true, + -- disable strict checking. + -- TODO: assemble a full list of globals so we can enable this + -- allowedGlobals = false + }) + +table.insert(package.loaders or package.searchers, fennel.searcher) +debug.traceback = fennel.traceback + +-- require("lib") +require("init") -- load ~/.config/awesome/init.fnl +#+end_src + +Now everything can be configured in your init.fnl. + +To learn more about fennel go here. https://fennel-lang.org/tutorial