https://github.com/pmeinhardt/huckleberry
raspberry pi configuration via dotfiles 🫐
https://github.com/pmeinhardt/huckleberry
dotfiles raspberry-pi
Last synced: 10 months ago
JSON representation
raspberry pi configuration via dotfiles 🫐
- Host: GitHub
- URL: https://github.com/pmeinhardt/huckleberry
- Owner: pmeinhardt
- Created: 2016-07-08T06:28:05.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2020-08-04T22:18:28.000Z (over 5 years ago)
- Last Synced: 2025-02-06T06:22:25.206Z (12 months ago)
- Topics: dotfiles, raspberry-pi
- Language: Vim script
- Homepage:
- Size: 69.3 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# huckleberry
Your dotfiles are how you personalize your system. This is how I set up my Raspberry Pi (Raspbian).
## topical
Everything is built around topic areas. If you are adding a new area to your forked dotfiles — say, "Java" — you can simply add a `java` directory and put files in there. Anything with an extension of `.zsh` will get automatically included into your shell. Anything with an extension of `.symlink` will get symlinked without extension into `$HOME` when you run `script/link`.
## components
There are a few special files in the hierarchy.
- **bin/** - anything in here will be added to your `$PATH`
- **topic/*.zsh** - any files ending in `.zsh` will be loaded into your environment
- **topic/path.zsh** - any file named `path.zsh` is loaded first and is expected to setup `$PATH` or similar
- **topic/completion.zsh** - any file named `completion.zsh` is loaded last and is expected to setup autocomplete
- **topic/*.symlink** - any files ending in `*.symlink` get symlinked into your `$HOME`
## install
Prior to installing these files, you may want to perform the [basic setup tasks](https://gist.github.com/pmeinhardt/893f9ca32b9baf8794cda08c27001c03) on your new Pi like configuring network access, expanding the filesystem, changing the default password and such.
If you do not have git installed (not installed on Raspbian by default), run:
```shell
apt-get install git
```
Then run this:
```shell
git clone https://github.com/pmeinhardt/huckleberry.git ~/.dotfiles
cd ~/.dotfiles
./script/link
```
This will symlink the appropriate files in `~/.dotfiles` to your home directory. Everything is configured and tweaked within `~/.dotfiles`.
The main file you'll want to change right off the bat is `zsh/zshrc.symlink`, which sets up a few paths that'll be different on your particular machine.
## more
For a completely automated setup of your Pi, including SSH keys, installing software and additional configuration as well as these dotfiles, see [pmeinhardt/huck-up](https://github.com/pmeinhardt/huck-up).
## thanks
Although huckleberry is tailored to a very different system (Raspbian, not OS X) and written with a very different focus, the main ideas and structure are clearly stolen from [Zach Holman](https://github.com/holman)'s excellent [dotfiles](https://github.com/holman/dotfiles).