https://github.com/pfac/.files
Home sweet home
https://github.com/pfac/.files
Last synced: 5 months ago
JSON representation
Home sweet home
- Host: GitHub
- URL: https://github.com/pfac/.files
- Owner: pfac
- License: gpl-3.0
- Created: 2011-12-09T01:05:53.000Z (over 14 years ago)
- Default Branch: main
- Last Pushed: 2025-04-15T15:20:49.000Z (about 1 year ago)
- Last Synced: 2026-01-15T00:44:25.178Z (6 months ago)
- Language: Shell
- Homepage:
- Size: 357 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# pfac's home
[][travis-build]
[][semaphore-build]
Home is where I have all my toys, configurations and shortcuts ready for me to
play with. And that's what this repository is, it makes a home in the systems I
use.
## Batteries included
Here's a quick gist of what you should find in this repository:
- A couple of (probably) useful tools to be placed in `~/.local`;
- Generic shell, [Bash][bash] and [Zsh][zsh] configurations (I tend to prefer
the latter for now);
- Terminal emulators configurations and color schemes;
- [Git][git] configurations;
- [Tmux][tmux] configurations;
- [Vim][vim] and [NeoVim][neovim] configurations;
- And probably some more stuff lying around.
## Installation
Simply clone this repository into your computer and copy/link whatever files
you want to use to the locations each tool expects.
### With a script (work-in-progress)
Simply paste this in a terminal prompt and let the magic :sparkles: happen:
curl -fsSL https://raw.githubusercontent.com/pfac/.files/master/bin/install | /bin/sh
Or, if you already cloned the repository, just run:
bin/install
Here's what this (supposedly) idempotent script will do:
1. Check the system for a package manager, and installs one if not found;
2. Check the system for installations of [Ansible][ansible] and [Git][git], and
use the package manager to install them if not found;
3. Clone the repository into `~/Developer/pfac/.files`;
4. Run `bin/provision`, which will use Ansible to provision the system.
### How do I know that script is safe?
It is [open-source](https://github.com/pfac/.files/blob/master/bin/install),
which means you can actually see what it does. It should be fairly readable
despite my tendency to over-complicate simple things.
## Provisioning
For now, most of the provisioning process is manual. You're in charge of copying
the relevant files to their expected locations.
### With a script (work-in-progress)
bin/provision
This script will use [Ansible][ansible] to provision the current system with
these preferences. Check the builds on [Travis CI][travis-build] and
[Semaphore CI][semaphore-build] for the supported macOS and Linux systems
(respectively).
Depending on the system this will actually cause very distinct behaviours.
Currently moving most things to reusable Ansible roles to support both Ubuntu
and ArchLinux.
## License
This project is published under the [GNU General Public License v3.0][license].
### Why GPL 3.0?
Because it is a highly permissive usage license which forces others using this
project to publish their derivative works with the same license, thus allowing
others to learn from them.
I hope using such a license serves the purpose of encouraging others to share
their knowledge.
[ansible]: https://www.ansible.com/
[bash]: https://www.gnu.org/software/bash/
[git]: https://git-scm.com/
[license]: /LICENSE.txt
[neovim]: https://neovim.io/
[tmux]: https://github.com/tmux/tmux
[vim]: https://www.vim.org/
[zsh]: http://www.zsh.org/
[semaphore-build]: https://semaphoreci.com/pfac/files
[travis-build]: https://travis-ci.org/pfac/.files