From 7a1fac5560360685505122708cf92c40ab3c4031 Mon Sep 17 00:00:00 2001 From: BirDt_ Date: Tue, 13 Jan 2026 21:29:23 +0800 Subject: [PATCH] readme updates --- README.org | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.org b/README.org index 486a06a..8a93d6d 100644 --- a/README.org +++ b/README.org @@ -11,9 +11,9 @@ Development is guided by these principles (but probably is not strictly adherent * Dependencies Some packages or flows within Theurgy have external dependencies. Typically, in this case we check if the dependency exists (or we hope that the downstream package does that for us). The complete list of packages with external dependencies is here for your perusal. -- [[https://github.com/vedang/pdf-tools][pdf-tools]]: requires epdfinfo. This is disabled on Windows systems by default, customize =theurgy-enable-pdf-tools-windows=. -- [[https://github.com/xenodium/ready-player][ready-player]]: requires mpv and ffmpeg. This is disabled on Windows systems by default, customize =theurgy-enable-ready-player-windows=. -- [[https://github.com/akermu/emacs-libvterm][vterm]]: requires libvterm. This is disabled on Windows systems by default, customize =theurgy-enable-vterm-windows=. If vterm is not available, theurgy will fall back to the standard Emacs shell for terminal emulation. +- [[https://github.com/vedang/pdf-tools][pdf-tools]]: requires epdfinfo. This is disabled on Windows systems by default, customize =theurgy-enable-pdf-tools=. +- [[https://github.com/xenodium/ready-player][ready-player]]: requires mpv and ffmpeg. This is disabled on Windows systems by default, customize =theurgy-enable-ready-player=. +- [[https://github.com/akermu/emacs-libvterm][vterm]]: requires libvterm. This is disabled on Windows systems by default, customize =theurgy-enable-vterm=. If vterm is not available, theurgy will fall back to the standard Emacs shell for terminal emulation. Here is the complete list of other optional dependencies: - [[https://github.com/hunspell/hunspell][Hunspell]]: if Hunspell is installed, Theurgy will use it and a dictionary file in the =user-emacs-directory= to provide completions with both flyspell and ispell. The =theurgy-hunspell-dict= variable can be customized to select a different dictionary than the =en_AU.dict= used by default. Additionally, the =ispell-dictionary= and =ispell-local-dictionary-alist= variables should be customised accordingly to get rid of the =en_AU= locale. @@ -56,7 +56,7 @@ This is a list of files/flows that are very opinionated and you may wish to dele ** Org-Mode My =org-mode= workflow is _VERY_ opinionated, and at the time of writing a lot of values are hard-coded. -The whole =workflows/org-custom.el= file assumes a directory tree like this in =~/.org=: +The whole =workflows/org-custom.el= file assumes a directory tree like this in =theurgy-org-directory=: #+begin_src fundamental . @@ -76,7 +76,7 @@ The whole =workflows/org-custom.el= file assumes a directory tree like this in = └── career #+end_src -You can read more about this configuration [[https://www.cyan.sh/blog/posts/architecting-a-better-org-workflow.html][here]], but you may wish to =M-% ~/.org= to your own org directory, or simply get rid of all irrelevant code. +You can read more about this configuration [[https://www.cyan.sh/blog/posts/architecting-a-better-org-workflow.html][here]], but you may wish to change the =theurgy-org-directory= to a new directory. * Workflow @@ -103,3 +103,6 @@ Theurgy can be extended by placing any arbitrary Emacs Lisp files in =./workflow ** Godot Setup Set the external exec path to ~/usr/bin/emacsclient~ and the exec flags to ~+{line}:{col} {file}~ + +** Weather (through BOM) +Theurgy can fetch and display the weather forecast for Australian locations from BOM. This requires setting a geohash, which can be done with ~M-x theurgy-weather-find-geohash~ and searching for your postcode or suburb. Once set, ~theurgy-weather~ will show the weather in a new buffer (also easily accessible from the dashboard with ~w~) and ~theurgy-weather-quick~ will show the weather in the modeline.