Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/midchildan/dotfiles
My personal dotfiles.
https://github.com/midchildan/dotfiles
doom-emacs dotfiles home-manager nix tmux vim zsh
Last synced: about 2 months ago
JSON representation
My personal dotfiles.
- Host: GitHub
- URL: https://github.com/midchildan/dotfiles
- Owner: midchildan
- License: mit-0
- Created: 2015-10-18T07:09:51.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T16:57:46.000Z (6 months ago)
- Last Synced: 2024-04-08T19:01:46.512Z (6 months ago)
- Topics: doom-emacs, dotfiles, home-manager, nix, tmux, vim, zsh
- Language: Nix
- Homepage: https://www.midchildan.org/dotfiles/
- Size: 2.45 MB
- Stars: 21
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dotfiles
dotfiles for my personal use.
[![Build][build-badge]][build-url]
## Requirements
### Nix Package Manager
Consult the following for more details.
- [Official website](https://nixos.org)
- [Official docs](https://nixos.org/learn.html)
## Installation
### Step 1: Preparation
Drop into a [nix-shell][nix-shell] with the following command. This would
download some commands required for setup, open a new temporary shell, and make
the commands available through `PATH`.
```console
$ system="$(nix-instantiate --eval -E 'builtins.currentSystem' | tr -d '"')"
$ nix-shell -A "devShells.$system.setup" 'https://github.com/midchildan/dotfiles/archive/main.tar.gz'
$
```
### Step 2: Setup your repository
Fork this repository and clone it to your location of choice. Then edit
`nix/config.nix` and commit the changes.
```console
$ git clone https://github.com/${USER}/dotfiles.git ~/Documents/src/repos/github.com/${USER}/dotfiles
$ cd ~/Documents/src/repos/github.com/${USER}/dotfiles
$ nvim nix/config.nix
$ git commit -am 'chore: adjust config.nix for my own use'
```
### Step 3: Checkout the relevant branch
Using the table in the [Supported Platforms](#supported-platforms) section,
checkout the most relevant branch for your platform. Note that instead of
checking out your chosen branch directly, it is recommended that you create a
`local` branch based on your chosen branch that is tied to your local machine
and check it out to a separate path for deployment. This way, you can make edits
on any branch without affecting your current configuration.
```console
$ git branch --track local # create local branch
$ git worktree add ~/.config/dotfiles local # checkout local branch
```
### Step 4: Symlink dotfiles
Run the setup script. This script would symlink files in [files](files) to your
home directory. It should be run each time changes are made to your dotfiles
even after bootstrapping is complete. The `--init` flag indicates that this is
the first time you've run this script.
```console
$ ./setup.sh --init
```
### Step 5: Bootstrap NixOS / Nix-Darwin / Home Manager Configuration
For details about each, read the docs linked below. Pick the ones you need and
configure them as needed before proceeding.
| Software | File | Required? |
| ------------ | -------------------------------------------- | --------- |
| Home Manager | [nix/home/README.md](nix/home/README.md) | yes |
| NixOS | [nix/nixos/README.md](nix/nixos/README.md) | no |
| Nix-Darwin | [nix/darwin/README.md](nix/darwin/README.md) | no |
Bootstrapping instructions for each are listed below. Home Manager can
optionally be integrated into NixOS or Nix-Darwin. If you do this, NixOS or
Nix-Darwin would take care of bootstrapping Home Manager for you.
- Home Manager:
```console
$ nix run '.#home' -- switch --flake .
```
- NixOS:
```console
$ sudo nix --experimental-features 'nix-command flakes' run '.#os' -- switch --flake '.#'
```
- nix-darwin:
```console
$ nix --experimental-features 'nix-command flakes' run '.#os' -- switch --flake '.#'
$ sudo -H nix-env -e '*' # remove existing packages not managed by nix-darwin
```
## Supported platforms
| branch | platform |
| ------ | -------- |
| main | Linux |
| osx | macOS |
In addition to the platforms listed above, support for one-off remote Linux
sessions is included in the `gh-pages` branch. This is useful in cases where
it's cumbersome to maintain a full-blown dotfiles, e.g. docker sessions, servers
you rarely login to directly, etc. Notably, this branch doesn't require Nix. See
[here](https://www.midchildan.org/dotfiles) for details.
Changes common to all platforms should first be made in `main`, and then merged
into the remaining branches. Make sure you never go the other way and merge
non-`main` branches into `main` or you'll end up with non-common
platform-specific stuff in `main`.
[build-badge]: https://github.com/midchildan/dotfiles/actions/workflows/build.yaml/badge.svg
[build-url]: https://github.com/midchildan/dotfiles/actions/workflows/build.yaml
[nix-shell]: https://nixos.wiki/wiki/Development_environment_with_nix-shell