Skip to content

Latest commit

 

History

History
146 lines (102 loc) · 2.83 KB

README.md

File metadata and controls

146 lines (102 loc) · 2.83 KB
Raw

Dotfiles

Release MIT License

My dotfiles managed with

Requirements

Initial Bootstrap

Note: the only requirement for the initial bootstrap is Zsh.

Because this installs a new .zshrc, you should restart your shell before proceeding.

Quick Start

Note that the install script takes care of everything except installing Node via nvm. Thus, a full install might look like

$ ./bootstrap.zsh
$ exit # reload shell after installing zshrc
$ nvm install
$ nvm use
$ ./install.zsh

Pull future updates with

$ git pull
$ ./install.zsh update

Installation and Usage

If you prefer a clean start, clone the minimal branch: it has the same structure and tools but with a very minimal configuration. Tagged releases are based on that branch.

Bootstrap with

$ ./bootstrap.zsh

Install dependencies with

$ npm install

Note that some npm dependencies on this branch may point to private repositories. You will either need to replace or remove these. Otherwise you can start with the minimal branch.

Install the dotfiles with

$ npm start

Update external applications with

$ ./update.zsh

Setup systemd/User units with

$ ./units.zsh

Run everything above with

$ ./install.zsh

This will skip updating external packages.

To install and update everything, run

$ ./install.zsh update

To only install the configuration files and units,

$ ./install.zsh config

Additional manual configuration is documented in NOTES.md.

Contributing

Please submit and comment on bug reports and feature requests.

To submit a patch:

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

License

These configuration files are licensed under the MIT license.

Warranty

This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.