From 74f1e8d52e05c535e5b67e9ee0c2fcdaab51e84e Mon Sep 17 00:00:00 2001
From: Alexandre Tuleu <alexandre.tuleu.2005@polytechnique.org>
Date: Fri, 4 Nov 2022 10:27:39 +0100
Subject: [PATCH] Adds a README

---
 README.md  | 24 ++++++++++++++++++++++++
 install.sh |  1 -
 2 files changed, 24 insertions(+), 1 deletion(-)
 create mode 100644 README.md
 delete mode 120000 install.sh

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e3d3dc2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Personnal configuration
+
+## Installation
+You can install this configuration on a new system using
+
+```bash
+curl -sSL https://git.tuleu.science/atuleu/home/raw/branch/master/update.sh | bash
+```
+
+## Keeping it synced
+
+You can then update the configuration with:
+
+```bash
+$HOME/.home/update.sh
+```
+
+On a GNOME environment you may want to:
+
+```bash
+$HOME/.home/update.sh --gnome
+```
+
+This will install necessary fonts and makes GNOME terminal actually looks good.
diff --git a/install.sh b/install.sh
deleted file mode 120000
index 75f574d..0000000
--- a/install.sh
+++ /dev/null
@@ -1 +0,0 @@
-update.sh
\ No newline at end of file