Skip to content

Latest commit

 

History

History
112 lines (76 loc) · 2.91 KB

README.md

File metadata and controls

112 lines (76 loc) · 2.91 KB
Raw

pufferfish

pufferfish

Add useful defaults and configuration files for

  • Nix,
  • tmux,
  • neovim,
  • fish,
  • and many more.

Using on macOS

Initial installation:

git clone git@github.com:justuswilhelm/pufferfish.git "$HOME/.dotfiles"
darwin-rebuild switch --flake "$HOME/.dotfiles/nix/generic"

Rebuild:

# In fish run the following function
rebuild

Using on Debian

Requirements are:

Furthermore, to properly use the window manager, you need to have installed (using apt)

  • sway
  • swaylock
  • swayidle

All other dependencies will be installed using home manager.

Initial installation:

git clone git@github.com:justuswilhelm/pufferfish.git "$HOME/.dotfiles"
home-manager --extra-experimental-features flakes --extra-experimental-features nix-command switch --flake $HOME/.dotfiles/nix/generic

Rebuild:

# In fish run the following function
rebuild

Formatting the code

There is a nix flake in the root directory that installs prettier. Inside a nix develop shell, you can run

prettier --check .

to check everything. If you want to format everything, run

prettier --write .

How to report a bug

You can file an issue here

How to contribute code

I am happy about accepting new contributions into this repository. You can file a pull request right here.

The best way to get started is by forking this repository and developing a new feature or bug fix on your own repository. Then, you can create a pull request to contribute the code back.

License

Copyright (c) 2014-2024 Justus Perlwitz

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Credits

  • Iosevka (fonts/): SIL Open Font License v1.1, refer to fonts/LICENSE.md
  • 24-bit-color (bin/24-bit-color): GPL v2, https://github.com/gnachman/iTerm2/blob/master/LICENSE
  • neovim selenized colors (nvim/colors/selenized.vim): MIT License, see nvim/colors/LICENSE.txt
  • iterm2 & alacritty selenized colors (selenized/terminals/iterm): MIT License, see selenized/LICENSE.txt