summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSuleyman Farajli <suleyman@farajli.net>2024-02-18 17:55:45 +0400
committerSuleyman Farajli <suleyman@farajli.net>2024-02-18 17:55:45 +0400
commitb1723f31684c18b308815b4760df38f07b05aa80 (patch)
treee7ed8f97e34b26bb766f0b915084a58ccd2d39ed
parentae366b3db916fc361a950e8e450e00cdc96178e1 (diff)
updated README
-rw-r--r--README.md32
1 files changed, 8 insertions, 24 deletions
diff --git a/README.md b/README.md
index 61f9948..83fe51a 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,18 @@
# Suleyman's Linux configuration files (SLCF)
-## 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)
+## Some of Contents
+* Some simple scripts
+* Gruvbox themed configuration
+* Neovim config with bootstraping packer
+* More
-export DEST_HOME=/home/$USER #give the user's home directory as the destination directory for installing the dotfiles (useful when running with sudo)
-
-make install (or sudo make install if you want to install anything to the root directory)
-
-```
+## Installation
-Or if you don't know what you are doing you might just run the following command,
-but be aware that this will overwrite you existing configuration files.
+build.sh won't overwrite your current config unless you tell it so.
```
-CONFIRM_SCRIPTS=true CONFIRM_DOTFILES=true DEST_HOME=/home/theion sudo make install
+sh build.sh
```
-### 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