aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGene Pasquet <dev@etenil.net>2025-02-12 07:19:53 +0000
committerGene Pasquet <dev@etenil.net>2025-02-12 07:19:53 +0000
commit0a7b63b80802c762c5b7cfa08056f25c93bb1397 (patch)
tree00af0d8f2718e0a692bfeb33fbf0c703e6dcfeb6
parent4a7d1fa68b9ec9c3aefc741a22348f604b973a11 (diff)
Add installer instructions
-rw-r--r--README.md4
-rwxr-xr-xinstaller/installer.sh1
2 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index ed4d982..9f54d1b 100644
--- a/README.md
+++ b/README.md
@@ -21,9 +21,11 @@ This is a minimal Emacs base config. Here's the short of the philosophy:
Copy and paste the following into a terminal:
```
-curl
+curl https://raw.githubusercontent.com/Etenil/emacs-substrate/refs/heads/main/installer/installer.sh | bash
```
+This will install emacs-substrate in your `~/.emacs.d` folder. You can set the environment variable `EMACS_DIR` before running the script to install it in a different folder.
+
### Manually
To install emacs-substrate, clone this repository somewhere, then create the following 2 files:
diff --git a/installer/installer.sh b/installer/installer.sh
index e147657..f2b4e56 100755
--- a/installer/installer.sh
+++ b/installer/installer.sh
@@ -21,3 +21,4 @@ cp emacs-substrate/installer/init.el init.el
popd
+echo "All done! Enjoy Emacs Substrate!"