An open API service indexing awesome lists of open source software.

https://github.com/scottames/dots

~
https://github.com/scottames/dots

dotfiles dots no-place-like-home

Last synced: 3 months ago
JSON representation

~

Awesome Lists containing this project

README

          

# dots

โšก Scotty's dotfiles

[![forthebadge](assets/image/built-for-linux.svg)](https://forthebadge.com) [![forthebadge](assets/image/works-on-my-machine.svg)](https://forthebadge.com)

[![chezmoi init](https://github.com/scottames/dots/actions/workflows/pr_chezmoi_init.yaml/badge.svg)](https://github.com/scottames/dots/actions/workflows/pr_chezmoi_init.yaml)
[![trunk.io](https://github.com/scottames/dots/actions/workflows/pr_trunkio.yaml/badge.svg)](https://github.com/scottames/dots/actions/workflows/pr_trunkio.yaml)

## ๐Ÿš€ init

Requirements: `curl`, `git`, and `go`

> ๐Ÿ™ˆ Don't do this at home.

```shell
curl -fsLS https://raw.githubusercontent.com/scottames/dots/main/scripts/init.sh | bash

```

Optionally, pass additional params to `chezmoi init`

```shell
curl -fsSL -O "https://raw.githubusercontent.com/scottames/dots/main/scripts/init.sh" && chmod +x init.sh && ./init.sh --branch
```

> โš  written solely for Linux systems

## ๐Ÿ”ง Tools of Note

| project | description |
|:----------------------------------------------------|:-----------------------------------------------------------------------------------------------------|
| [alacritty](https://alacritty.org/) | modern terminal emulator that comes with sensible defaults, but allows for extensive configuration |
| [aqua](https://aquaproj.github.io/) | declarative cli version manager |
| [chezmoi](https://www.chezmoi.io/) | manage your dotfiles across multiple diverse machines, securely |
| [fish](https://fishshell.com/) | smart and user-friendly command line shell |
| [lazygit](https://github.com/jesseduffield/lazygit) | simple terminal UI for git commands |
| [mage](https://magefile.org/) | make/rake-like build tool using golang |
| [neovim](https://neovim.io/) | hyperextensible Vim-based text editor |
| [paperwm](https://github.com/paperwm/PaperWM) | experimental Gnome Shell extension providing scrollable tiling of windows and per monitor workspaces |
| [starship](https://starship.rs/) | minimal, blazing-fast, and infinitely customizable prompt for any shell! |
| [trunk.io](https://trunk.io/) | check, merge, and monitor your code |
| [wezterm](https://wezfurlong.org/wezterm/) | a powerful cross-platform terminal emulator and multiplexer |
| [zellij](https://zellij.dev/) | terminal workspace with batteries included |

## ๐Ÿงช Testing

Runs linter checks, go tests, and chezmoi init inside a docker container

```shell
mage check && mage test
```

- Requires: docker, go, mage, trunk

## ๐Ÿ“œ Terms

Use at your own risk!

## โ™ฅ Credits

"Nothing is original." Especially these dotfiles. Everything included here is heavily inspired by many giants that have come before me.

Some (far from all) noteworthy sources:

* https://github.com/sheldonhull/dotfiles-starter
* https://github.com/webpro/awesome-dotfiles
* https://github.com/folke/dot
* https://github.com/twpayne/dotfiles
* https://github.com/szorfein/dots
* https://github.com/ThePrimeagen

## โš–๏ธ License

The code is available under the [MIT license](LICENSE).