docs: update README
This commit is contained in:
parent
2e77243058
commit
750ae0a273
29
README.md
29
README.md
|
@ -1,34 +1,26 @@
|
||||||
# dotfiles
|
# dotfiles
|
||||||
|
|
||||||
My personal dotfiles, originally for macOS only but currently being adapted for
|
Cross-platform development environments for opdavies using NixOS and Home Manager.
|
||||||
use on Linux based systems (Ubuntu and Pop!_OS in particular) where needed.
|
|
||||||
|
|
||||||
The repository is powered using Ansible, with each software package and its
|
## Why did you move from Ansible?
|
||||||
associated configuration within separate roles within the `roles` directory.
|
|
||||||
|
|
||||||
The `neovim` role, for example, has its own tasks in `roles/neovim/tasks/main.yaml`
|
TBD.
|
||||||
and files in `roles/neovim/files`.
|
|
||||||
|
|
||||||
Files within a role are typically symlinked into their required destination
|
## Why NixOS?
|
||||||
so that they will be automatically updated without needing to run the playbook
|
|
||||||
again.
|
|
||||||
|
|
||||||
For example, the files and directories within the neovim role are symlinked
|
TBD.
|
||||||
into `~/.config/nvim`.
|
|
||||||
|
|
||||||
## Requirements
|
## Why Home Manager?
|
||||||
|
|
||||||
- [Ansible](https://www.ansible.com)
|
TBD.
|
||||||
- [Git](https://git-scm.com)
|
|
||||||
|
|
||||||
## Installation
|
## NixOS vs WSL2 (Windows)
|
||||||
|
|
||||||
```
|
TBD.
|
||||||
$ ansible-playbook main.yaml --ask-become-pass
|
|
||||||
```
|
|
||||||
|
|
||||||
## Inspiration
|
## Inspiration
|
||||||
|
|
||||||
|
- [ALT-F4-LLC](https://github.com/ALT-F4-LLC/dotfiles-nixos)
|
||||||
- [Chris Toomey](https://github.com/christoomey/dotfiles)
|
- [Chris Toomey](https://github.com/christoomey/dotfiles)
|
||||||
- [Gabe Berke-Williams](https://github.com/gabebw/dotfiles)
|
- [Gabe Berke-Williams](https://github.com/gabebw/dotfiles)
|
||||||
- [Jeff Geerling](https://github.com/geerlingguy/dotfiles)
|
- [Jeff Geerling](https://github.com/geerlingguy/dotfiles)
|
||||||
|
@ -38,3 +30,4 @@ $ ansible-playbook main.yaml --ask-become-pass
|
||||||
- [ThePrimeagen](https://github.com/ThePrimeagen/.dotfiles)
|
- [ThePrimeagen](https://github.com/ThePrimeagen/.dotfiles)
|
||||||
- [Thoughtbot](https://github.com/thoughtbot/dotfiles)
|
- [Thoughtbot](https://github.com/thoughtbot/dotfiles)
|
||||||
- [codico](https://github.com/codicocodes/dotfiles)
|
- [codico](https://github.com/codicocodes/dotfiles)
|
||||||
|
- [kensodev](https://github.com/KensoDev/dotfiles)
|
||||||
|
|
Loading…
Reference in a new issue