https://github.com/tpgillam/dotfiles

https://github.com/tpgillam/dotfiles

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/tpgillam/dotfiles
• Owner: tpgillam
• Created: 2021-02-06T15:21:16.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-14T09:52:25.000Z (about 1 year ago)
• Last Synced: 2023-12-14T11:11:44.507Z (about 1 year ago)
• Language: Vim Script
• Size: 4.8 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
I am Tom's configuration files!

# Installation

## Dependencies

The following should be installed before starting:

- git

- dircolors

- tmux

- neovim

- ripgrep

### Suggested dependencies

Other tools that might be useful:

- tree

- Rust via [rustup](https://rustup.rs/)

- Julia via [juliaup](https://github.com/JuliaLang/juliaup)

- Python via [pyenv](https://github.com/pyenv/pyenv) and [poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)

## Configuration files

Run `./install`. This will install most configuration (idempotently) with some exceptions:

### `bash_profile`

The purpose of this file is to set `PATH` and other environment variables that are system specific, and/or are not idempotently updated.

Some subset of the contents of this file should be adapted into `~/.bash_profile` or `~/.profile`,

depending on how your system is configured.

Note that all other idempotent shell configuration (e.g. functions, aliases, prompt) are stored in `~/.bashrc`.

This file is designed to be portable.

## Optional setup

### Rust + vim integration

Need to install [rustup](https://rustup.rs/), and then `rust-analyzer` with:

```

rustup component add rust-analyzer

```

### Python + vim integration

For a sensible experience, work in a python virtual environment managed e.g. by poetry.

The environment _must_ be activated before starting neovim, otherwise pyright will complain about missing imports.

Ruff 'fix all' is registered as a code action (so do `a` in the desired buffer and follow instructions).

### fzf

[fzf](https://github.com/junegunn/fzf) is a fuzzy finder that can integrate with the shell.

Ideally, install it and create `~/.fzf.bash` that will source the completions file, e.g.

```bash

. /usr/share/fzf/shell/key-bindings.bash

```

(naturally this path will be OS dependent).