Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/koombea/dotfiles

dotfiles git vim zsh

Last synced: 15 days ago
JSON representation

Host: GitHub
URL: https://github.com/koombea/dotfiles
Owner: koombea
Created: 2015-08-14T19:32:05.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2024-04-22T18:38:23.000Z (7 months ago)
Last Synced: 2024-07-30T21:09:24.533Z (3 months ago)
Topics: dotfiles, git, vim, zsh
Language: Vim script
Size: 52.7 KB
Stars: 5
Watchers: 7
Forks: 2
Open Issues: 13
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Dotfiles
## Koombea dotfiles

Dotfiles is a collection of configuration files used at Koombea to customise different development tools. This project's goal is to standardise a part of our work environment to make working more pleasant.

## What are dotfiles?
Dotfiles are basically plain text files that start with a '.' and are use to set preferences for things like Git and Vim. To see your current dotfiles, open a terminal and in your home folder run this:

```
$ ls -a
```

## Install

First clone the repo:

```
$ git clone [email protected]:koombea/dotfiles.git
```

Then cd into the dotfiles directory and run this script:

```
$ cd dotfiles
$ bin/install
```

This will symlink all dotfiles into your home directory.

This script will only install files that do not already exist in your $HOME directory. if you have, e.g. your own .vimrc file, the script will rename it as .vimrc.old so you can get what you need from there and move it into ~/.vimrc.local. Do not worry! Dotfiles will source it for you.

### Extras

This script will install extra tools required for some plugins functionality. It's not mandatory to install the extras, but it is highly recommended. The script will work on Mac or Linux (Ubuntu):

```
bin/extras.sh
```

It will install:

- Silver Searcher (Vim)
- Autojump (Oh-My-Zsh)

## Update

To keep dotfiles up to date, just go into dotfiles home directory and run:

```
$ git pull --rebase
$ bin/install
```

## Uninstall

Cd into dotfiles home directory and run this script:

```
$ bin/uninstall
```

## Contributing

1. Fork it ( https://github.com/koombea/dotfiles/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## License