sqrtminusone/dotfiles
1
0
Fork 0
mirror of https://github.com/SqrtMinusOne/dotfiles.git synced 2025-12-10 19:23:03 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update comments

Browse source
This commit is contained in:
Pavel Korytov 2022-01-18 18:31:26 +03:00
parent 90d7c91f0c
commit 7971eb63e5
2 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
Emacs.org
View file

@ -16,7 +16,7 @@ At the moment of this writing, this "almost anything" includes:
- *Writing code*. With LSP & Co this functionality of Emacs may rival that of IDEs, and is at least on par with editors like VS Code.\\
One thing where Emacs is particularly good is writing Lisp code, e.g. Clojure, Common Lisp, and, of course, Emacs Lisp.
- *Literate programming* with Org Mode. That includes:
- Configuring the entirety of my software that can be configured with text files.
- Configuring the entirety of my software (that can be configured with text files).
- Interactive programming like one provided by Jupyter Notebook.
- *File management*. Dired is my primary file manager.
- *Email*, with notmuch.
@ -29,9 +29,9 @@ At the moment of this writing, this "almost anything" includes:
- *X Window management*, with EXWM. So I could say I literally live in Emacs.
- ...
As I have hinted above, this file is a piece of literate configuration, which means that the actual code is interweaved with English-language commentary. One could argue that the commentary, not the code, is the primary entity of the file.
As I have hinted above, this file is a piece of literate configuration, which means that the actual code is interweaved with English-language commentary. One could argue that the commentary, not the code, is the citizen entity of the file.
But at the same time, the configuration is personal, so in fact, the primary benefactor of the literate structure is me. The commentary is primarily meant to capture my state of mind at the moment of writing the code, which is immensely helpful for maintaining the code in the future. Besides, I can't say I'm stable with it.
But at the same time, the configuration is personal, so the primary benefactor of the literate structure is me. The commentary is primarily meant to capture my state of mind at the moment of writing the code, which is immensely helpful for maintaining the code in the future. So the quality and quantity of the commentary are... varying.
Occasionally I save some promising experimentations from scratch buffers without much comment. Or I may not have enough time to describe things in substantial detail. Or, as it is at the moment when I'm writing this, I have the time to write down whatever I consider necessary. Or, when I'm writing a blog post about Emacs configuration, I usually incorporate some things back into this config.

12
README.org
View file

@ -3,13 +3,15 @@
[[https://forthebadge.com/images/badges/works-on-my-machine.svg]]
A set of my GNU/Linux configuration files. [[https://github.com/SqrtMinusOne/dotfiles][View at GitHub]].
These are my GNU/Linux configuration files. [[https://github.com/SqrtMinusOne/dotfiles][View at GitHub]].
The majority of the software is configured with [[https://leanpub.com/lit-config/read][literate configuration]] strategy via Emacs' Org Mode. This way has its advantages and disadvantages, but overall it's pretty nice to keep the configs interweaved with comments in a handful of files.
Most of the software is configured with [[https://leanpub.com/lit-config/read][literate configuration]] strategy via Emacs' [[https://orgmode.org/][Org Mode]]. This way has its pros and cons, but overall it's pretty nice to keep the configs interweaved with comments in a handful of files.
The files themselves are managed and deployed via [[https://yadm.io/][yadm]], but I mostly use Org Mode rich noweb whenever I can instead of what yadm offers.
The files themselves are managed and deployed via [[https://yadm.io/][yadm]], but I use Org Mode for things like config templating.
My current GNU/Linux distribution is [[https://guix.gnu.org/][GNU Guix]]. In the context of this repo, Guix allows me to list all the used programs in manifests, which means I have the same set of programs across multiple machines. Look for tables with "Guix dependency" in the header.
My current GNU/Linux distribution is [[https://guix.gnu.org/][GNU Guix]]. I like Guix because, among other things, it allows [[https://guix.gnu.org/cookbook/en/html_node/Advanced-package-management.html#Advanced-package-management][declaring the required software]] in configuration files, so I can have the same set of programs across multiple machines (look for tables with "Guix dependency" in the header).
The central program to all of that is, of course [[https://www.gnu.org/software/emacs/][GNU Emacs]]. As of the moment of this writing, it takes ~50% of my screen time and has the largest share of configuration here.
Table of contents and software:
- [[file:Emacs.org][Emacs.org]]
@ -24,7 +26,7 @@ Table of contents and software:
- [[file:Mail.org][Mail.org]]
- /Active/: [[file:Mail.org::*Lieer][Lieer]], [[file:Mail.org::*DavMail][DavMail]], [[file:Mail.org::*OfflineIMAP][OfflineIMAP]], [[file:Mail.org::*Notmuch][Notmuch]]
(/Apparently, these links work only in Emacs 🙁/)
(/Apparently, links on the second level work only in Emacs 🙁/)
A few other repositories I may consider a part of my config:
- [[https://github.com/SqrtMinusOne/channel-q][channel-q]] is my Guix channel