diff --git a/README.org b/README.org deleted file mode 100644 index 4201fb18..00000000 --- a/README.org +++ /dev/null @@ -1,36 +0,0 @@ -# -*- eval: (org-make-toc-mode t); -*- -* Emacs Configuration -:PROPERTIES: -:TOC: :include descendants :depth 2 -:END: -[[https://akirak.cachix.org][file:https://img.shields.io/badge/cachix-akirak-blue.svg]] - -[[https://flakehub.com/flake/akirak/emacs-config][file:https://img.shields.io/endpoint?url=https://flakehub.com/f/akirak/emacs-config/badge]] - -This repository contains my Emacs configuration which is built using [[https://github.com/akirak/emacs-twist][emacs-twist]]. -I use home-manager to install the configuration. - -It is an org-babel configuration defined within [[file:emacs/emacs-config.org][a single file]]. - -Note: This configuration is currently built and tested only on Linux. -** Trying out -:PROPERTIES: -:ID: 3cc635d1-7bad-4d28-946e-e204b04aafaa -:END: -If you have Nix 2.9+ installed, you can try out the Emacs configuration without installing it. - -There are two variants of the configuration. -One is built with the pgtk version of Emacs, which runs on Wayland: - -#+begin_src bash - nix run github:akirak/emacs-config#default-pgtk.wrappers.tmpdir -#+end_src - -There is another version, an X11 variant, which is now discouraged: - -#+begin_src bash - nix run github:akirak/emacs-config#default-x11.wrappers.tmpdir -#+end_src - -Both commands create a temporary directory which will be used as ~user-emacs-directory~ containing an init file. -The temporary directory will be cleaned up when Emacs exits. diff --git a/README.org b/README.org new file mode 120000 index 00000000..73b3e60e --- /dev/null +++ b/README.org @@ -0,0 +1 @@ +emacs-config.org \ No newline at end of file diff --git a/emacs/emacs-config.org b/emacs-config.org similarity index 99% rename from emacs/emacs-config.org rename to emacs-config.org index e0de8eb3..f12447b0 100644 --- a/emacs/emacs-config.org +++ b/emacs-config.org @@ -4,7 +4,15 @@ :TOC: :include descendants :depth 1 :END: +[[https://akirak.cachix.org][file:https://img.shields.io/badge/cachix-akirak-blue.svg]] + +[[https://flakehub.com/flake/akirak/emacs-config][file:https://img.shields.io/endpoint?url=https://flakehub.com/f/akirak/emacs-config/badge]] + +This repository contains my Emacs configuration which is built using [[https://github.com/akirak/emacs-twist][emacs-twist]]. +I use home-manager to install the configuration. + :CONTENTS: +- [[#trying-out][Trying out]] - [[#setupel][Setup.el]] - [[#performance][Performance]] - [[#supported-systems][Supported systems]] @@ -34,6 +42,29 @@ - [[#grep][Grep]] - [[#sh-emulation-keybindings][Sh-emulation keybindings]] :END: +** Trying out +:PROPERTIES: +:ID: 3cc635d1-7bad-4d28-946e-e204b04aafaa +:END: +If you have Nix 2.9+ installed, you can try out the Emacs configuration without installing it. + +There are two variants of the configuration. +One is built with the pgtk version of Emacs, which runs on Wayland: + +#+begin_src bash + nix run github:akirak/emacs-config#default-pgtk.wrappers.tmpdir +#+end_src + +There is another version, an X11 variant, which is now discouraged: + +#+begin_src bash + nix run github:akirak/emacs-config#default-x11.wrappers.tmpdir +#+end_src + +Both commands create a temporary directory which will be used as ~user-emacs-directory~ containing an init file. +The temporary directory will be cleaned up when Emacs exits. + + ** Setup.el :PROPERTIES: :SORTING_TYPE: a