diff options
| author | Thanos Apollo <[email protected]> | 2023-03-26 10:55:03 +0300 |
|---|---|---|
| committer | Thanos Apollo <[email protected]> | 2023-03-26 10:55:03 +0300 |
| commit | e483b1564394342b055972811a361ebdd4c80199 (patch) | |
| tree | 7680e3d2995360fd475ed87c329e88d0d555b6d2 /README.md | |
| parent | 7947dc69fdfc5b0dce140ba2c2fff1e6fb115485 (diff) | |
Redo org files under /org
Create a build-docs.el that publishes org configurations under /org to
./ as markdown, making easy to view on sourcehut
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 58 |
1 files changed, 0 insertions, 58 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index 264f2f3..0000000 --- a/README.md +++ /dev/null @@ -1,58 +0,0 @@ - - -# About - -Welcome to my dotfiles repository! - -Here you will find my custom configuration files for a variety of applications and utilities. All of which are written in org-mode literate configuration format. - -All of the configurations in this repository are managed using [GNU Stow](https://www.gnu.org/software/stow/), which allows me to easily manage and switch between different configurations for different systems or environments. - -- Hosted at [sourcehut](https://git.sr.ht/~thanos_apollo/dotfiles) - - -# Configurations - -- [Emacs](emacs.md) -- [Shells](shells.md) -- [Qtile](Qtile.md) - -*Qtile with emacs* -  - -Themes I'm using: - -- [Dracula for rofi](https://github.com/dracula/rofi) -- [Dracula for nyxt](https://github.com/dracula/nyxt) -- [Dracula for Qutebrowser](https://github.com/dracula/qutebrowser) -- [mocp-themes](https://github.com/wimstefan/mocp-themes) collection - - -# Installation - -- clone repository - - git clone https://github.com/ThanosApollo/dotfiles.git ~/dotfiles - -- Install [GNU stow](https://www.gnu.org/software/stow/) - - guix install stow # use the package manager of your distro if not guix - -- Use stow - - cd ~/dotfiles - stow . - -If you get any errors due to existing files, rename them with `_backup` at the end - -e.g `mv ~/.bashrc ~/.bashrc_backup` - - -# WARNING! - -It's important to note that my dotfiles in this repository are constantly evolving, as I am constantly experimenting with new configurations and settings. - -While I am happy to share my configurations, **I do not recommend using them as-is on your own system** without careful review and testing. - -It's possible that some configurations may not work as expected or may cause issues on your system. Therefore, I strongly recommend taking caution and reviewing any changes carefully before applying them to your own system. - |