Move emacs-config to the repository root

README.org

@@ -0,0 +1 @@
+emacs-config.org

emacs/emacs-config.org → 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