extern/dotfiles
1
0
Fork 0
mirror of https://github.com/Lissy93/dotfiles.git synced 2024-11-21 23:13:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Alicia Sykes 2022-09-01 19:55:05 +01:00 committed by GitHub
parent c8a1548c02
commit 6793c5e326
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
.github/README.md vendored
View File

@ -15,6 +15,8 @@
- [Security](#security)
- [My Dots](#my-dots)
- [Setup](#setup)
- [Directory Structure](#directory-structure)
- [Configuring](#configuring)
- [Aliases](#aliases)
- [Utilities](#utilities)
- [Packages](#packages)
@ -191,6 +193,23 @@ Once the repo is cloned, you can modify whatever files you like before running t
---
### Directory Structure
<pre>
~
└── <a href="https://github.com/Lissy93/dotfiles" title="Root">.</a>
├── <a href="https://github.com/Lissy93/dotfiles/tree/master/bash" title="Bash Config">bash/</a>
├── <a href="https://github.com/Lissy93/dotfiles/tree/master/tmux" title="Tmux Configs">tmux/</a>
├── <a href="https://github.com/Lissy93/dotfiles/tree/master/vim" title="Vim Configs">vim/</a>
├── <a href="https://github.com/Lissy93/dotfiles/tree/master/zsh" title="ZSH Configs">zsh/</a>
├── <a href="https://github.com/Lissy93/dotfiles/tree/master/.github" title="Repo Meta">.github/</a>
├── <a href="https://github.com/Lissy93/dotfiles/blob/master/lets-go.sh" title="Remote Setup Initiator">lets-go.sh</a>
└── <a href="https://github.com/Lissy93/dotfiles/blob/master/install.sh" title="Setup Script">install.sh</a>
</pre>
---
### Configuring
The locations for all symlinks are defined in [`.install.conf.yaml`](https://github.com/Lissy93/dotfiles/blob/master/.install.conf.yaml). These are managed using [Dotbot](https://github.com/anishathalye/dotbot), and will be applied whenever you run the [`install.sh`](https://github.com/Lissy93/dotfiles/blob/master/install.sh) script. The symlinks set locations based on XDG paths, all of which are defined in [`.zshenv`](https://github.com/Lissy93/dotfiles/blob/master/zsh/.zshenv).