summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSuleyman Farajli <suleyman@farajli.net>2024-02-10 00:03:26 +0400
committerSuleyman Farajli <suleyman@farajli.net>2024-02-10 00:03:26 +0400
commit905a70ab40b81a343e4fb019dd93f00dec24e4df (patch)
treecff5c0aa94946c88ae031821d456b09cc69687d1 /README.md
parentd8808683653aa32cea7e96dcedb06b4a04ff6025 (diff)
all environment variables were set to false
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..81e7ffd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Configuration files for gnu/linux systems
+
+## installation
+
+This software doesn't have any configure script at the moment,
+instead you are supposed to use environment variables to configure
+the Makefile, such as:
+
+```
+export CONFIRM_DOTFILES=true #enable installing the dotfiles
+
+export CONFIRM_SCRIPTS=true #enable installing scripts
+
+export CONFIRM_ARCH=true #enable installing arch specific (pacman.conf)
+
+DEST_HOME=/home/$USER #give the user's home directory as the destination directory for installing the dotfiles (useful when running with sudo)
+
+```
+
+Or you might just run all of them in one line, as:
+
+```
+export CONFIRM_DOTFILES=false export CONFIRM_SCRIPTS=true make install
+```
+
+### WARNING
+By default all environmental variables are false and if you want to install something at all you have to activate at least one environmental variable.
+
+
+## Author
+Farajli Suleyman