Add base configuration
- Follow XDG standard: ~/.config and ~/.local folders - Set environment variables and define aliases within ~/.config/shell - Add installation script for easy setup - Add README.md with info on the installation and general notes
This commit is contained in:
commit
74d1e2ab00
10 changed files with 258 additions and 0 deletions
52
README.md
Normal file
52
README.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
# Dotfiles
|
||||
|
||||
This repository contains useful (config) files.
|
||||
|
||||
There are two "production" branches:
|
||||
- [main](https://code.webartifex.biz/alexander/dotfiles/src/branch/main)
|
||||
- [desktop](https://code.webartifex.biz/alexander/dotfiles/src/branch/desktop)
|
||||
|
||||
`main` contains dotfiles intended to be used on all kinds of machines
|
||||
and can be thought of as a "minimal" or "server" version.
|
||||
`desktop` is (re-)based on top of `main`
|
||||
and adds "desktop" related dotfiles (e.g., GNOME stuff).
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
Simply run:
|
||||
|
||||
```sh
|
||||
curl https://code.webartifex.biz/alexander/dotfiles/raw/branch/main/.local/bin/install-dotfiles > install-dotfiles && sh ./install-dotfiles && rm ./install-dotfiles
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```sh
|
||||
wget https://code.webartifex.biz/alexander/dotfiles/raw/branch/main/.local/bin/install-dotfiles -O install-dotfiles && sh ./install-dotfiles && rm ./install-dotfiles
|
||||
```
|
||||
|
||||
This downloads a simple [installation script](.local/bin/install-dotfiles)
|
||||
and then executes it.
|
||||
The script has only one dependency, namely [git](https://git-scm.com).
|
||||
So, it should not be too hard to get this going.
|
||||
|
||||
When it finishes, reload your shell to start using the dotfiles:
|
||||
|
||||
```sh
|
||||
exec $SHELL -l
|
||||
```
|
||||
|
||||
For the *desktop* variant, run `export DOTFILES_BRANCH=desktop` before installation.
|
||||
|
||||
Normally, I advise against executing shell scripts from the internet,
|
||||
but this one is short enough to be read even by beginners.
|
||||
So, convince yourself that it is not harmful!
|
||||
|
||||
|
||||
## Shells
|
||||
|
||||
The config files in this repository are optimized for usage with
|
||||
[GNU's Bourne again shell](https://man7.org/linux/man-pages/man1/bash.1.html),
|
||||
or `bash` for short,
|
||||
and the popular [zsh](https://www.zsh.org/).
|
||||
Loading…
Add table
Add a link
Reference in a new issue