dotfiles/README.org

70 lines
3.1 KiB
Org Mode
Raw Normal View History

#+TITLE: Phundraks dotfiles
#+AUTHOR: Lucien Cartier-Tilet
#+EMAIL: lucien@phundrak.com
#+CREATOR: Lucien Cartier-Tilet
#+LANGUAGE: en
#+OPTIONS: auto-id:t H:4 broken_links:mark email:t ^:{}
#+KEYWORDS: dotfiles linux emacs configuration phundrak drakpa
* Table of Contents :TOC_4_gh:noexport:
:PROPERTIES:
:CUSTOM_ID: h-8044ee9a-2ee8-4d52-bad1-666c41a2a6a6
:END:
- [[#presentation][Presentation]]
- [[#wheres-the-config-file-for-x][Wheres the config file for X?]]
- [[#some-more-info-please][Some more info please?]]
- [[#neat-whats-the-license][Neat, whats the license?]]
* Presentation
:PROPERTIES:
:CUSTOM_ID: h-fbbf65b3-bf05-4466-80fb-b8f3d3094e47
:END:
This repository is where I keep most of my configuration files. With what is
stored here, anyone can recreate a working desktop configuration similar to my
daily one.
My dotfiles are managed by [[https://yadm.io/][yadm]], and although I dont use its alternate files
features (which is pretty neat btw), it allows me to painlessly manage my
dotfiles right where they are and not in a separate Git repository somewhere
with everything symlinked. Another advantage of yadm is it will automatically
execute (with your authorization, of course) my homemade bootstrap when my
dotfiles are cloned through yadm.
* Wheres the config file for X?
:PROPERTIES:
:CUSTOM_ID: h-42508121-fe51-48bb-bd22-9f8894902789
:END:
As you may have noticed, I am striving for a 100% amount of configuration
files exported from Org files, that is, through literary programming. This is
still very much a work in progress, but so far I achieved this for the
following configuration files:
- Email signature (not very hard I must admit) ([[file:org/config/index.org]])
- ~.gitignore_global~ (not very hard either) ([[file:org/config/index.org]])
- ~.rustfmt.toml~ ([[file:org/config/index.org]])
- My Xresources file ([[file:org/config/index.org]])
- [[file:org/config/bin.org][My custom scripts]]
- [[file:org/config/fish.org][My fish config]]
- [[file:org/config/i3.org][My i3 config]]
- [[file:org/config/installation.org][The installation bootstrap]]
- [[file:org/config/nano.org][My nano config]]
- [[file:org/config/polybar.org][My Polybar config]]
- [[file:org/config/polybar.org][My Emacs (Spacemacs) config]]
- And finally [[file:org/config/tmux.org][my Tmux config]]
* Some more info please?
:PROPERTIES:
:CUSTOM_ID: h-2b8488ed-8a5c-4292-ac4f-e47b7009c496
:END:
Everything you need to know is in my [[file:org/config/]] folder, and my Org files
are also available in web format on my website [[https://phundrak.com/config][phundrak.com/config]].
* Neat, whats the license?
:PROPERTIES:
:CUSTOM_ID: h-fc461244-3932-4680-88bc-73dc5e175213
:END:
All of my dotfiles (and my dotfiles only) are available under the GNU GPLv3
Licence. Please consult [[file:LICENCE.md]] for more information. In short: you
are free to access, edit and redistribute all of my dotfiles under the same
licence and as allowed by the licence, and if you fuck up something, its your
own responsibility.