dotfiles/README.org

54 lines
2.9 KiB
Org Mode
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#+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
#+html: <a href="https://www.gnu.org/software/emacs/"><img src="https://img.shields.io/badge/Emacs-30.0.50-blueviolet.svg?style=flat-square&logo=GNU%20Emacs&logoColor=white" /></a>
#+html: <a href="https://orgmode.org/"><img src="https://img.shields.io/badge/Org%20mode-litterate%20config-success?logo=Org&logoColor=white&style=flat-square"/></a>
#+html: <a href="https://archlinux.org/"><img src="https://img.shields.io/badge/OS-Arch%20Linux-10A0CC?logo=Arch%20Linux&logoColor=white&style=flat-square"/></a>
#+html: <a href="https://config.phundrak.com"><img src="https://img.shields.io/badge/dynamic/json?label=Online%20documentation&query=%24%5B%3A1%5D.status&url=https%3A%2F%2Fdrone.phundrak.com%2Fapi%2Frepos%2Fphundrak%2Fdotfiles%2Fbuilds&style=flat-square&logo=buffer" /></a>
* Presentation
:PROPERTIES:
:CUSTOM_ID: Presentation-e5605995
: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: Wheres_the_config_file_for_X?-7b214c4a
: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 though. Most of what you need can be found
in my [[file:org/config/index.org][index.org]] file and in its folder.
* Some more info please?
:PROPERTIES:
:CUSTOM_ID: Some_more_info_please?-f54ae73a
: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://config.phundrak.com/][config.phundrak.com]].
* Neat, whats the license?
:PROPERTIES:
:CUSTOM_ID: Neat,_whats_the_license?-399aa236
: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.