diff --git a/docs/fish.md b/docs/fish.md deleted file mode 100644 index 24525ec..0000000 --- a/docs/fish.md +++ /dev/null @@ -1,12 +0,0 @@ -# Fish Shell Customization - -This section defines a list of plugins used to customize fish. - -- [Tide](https://github.com/IlanCosman/tide) - The ultimate Fish prompt. -- [Fisher](https://github.com/jorgebucaran/fisher) - Manage functions, completions, bindings, and snippets from the command line. -- [Exa](https://the.exa.website/) - New gen `ls`. -- [Z](https://github.com/jethrokuan/z) - tracks the directories you visit and jump between them. -- [Peco](https://github.com/peco/peco) - Filterting tool. -- [Llama](https://github.com/antonmedv/llama) - Terminal file manager. -- [ghq](https://github.com/x-motemen/ghq) - Manage remote repository clones. - diff --git a/docs/linux.md b/docs/linux.md deleted file mode 100644 index c3f0637..0000000 --- a/docs/linux.md +++ /dev/null @@ -1,72 +0,0 @@ -# Linux Setup - -Follow the steps below to configure the dotfiles on Ubuntu. - -## Requirements - -### 1. Install Fish - -Visit [https://fishshell.com/](https://fishshell.com/) and follow the instructions to install fish on Ubuntu. - -Alternatively, follow these instructions for installing in Ubuntu. - -```bash -sudo add-apt-repository ppa:fish-shell/release-3 -sudo apt update -sudo apt install fish -``` - -Verify fish has been installed. - -```bash -which fish -``` - -Here is the list of [Fish customizations](/docs/fish.md). - -#### Make fish the default shell - -```bash -chsh -s $(which fish) -``` - -### 2. Install Min browser - -Minimalist browser - -Use the below command if running on Ubuntu: - -```fish -sudo dpkg -i /path/to/download -``` - -If not, visit [https://minbrowser.org/](https://minbrowser.org/). - -### 3. Install Neovim - -Install `v0.9.0` for all the plugins to work. The debian package can be download with this link: (This is not a stable release but the latest `v0.8.1` is showing problems with treesitter) - -- https://github.com/neovim/neovim/releases/download/nightly/nvim-linux64.deb - -After downloading the package, use the command below to install: - -```bash -sudo apt install ./nvim-linux64.deb -``` - -> Note: This installation assumes that you are using Ubuntu. - ---- - -#### Install Plugin Manager For Neovim - -We are using [packer](https://github.com/wbthomason/packer.nvim) as the plugin manager. - -Copy the code below to install: - -```bash -git clone --depth 1 https://github.com/wbthomason/packer.nvim\ - ~/.local/share/nvim/site/pack/packer/start/packer.nvim -``` - -Now it is time to [setup Neovim](/docs/nvim.md). diff --git a/docs/macos.md b/docs/macos.md deleted file mode 100644 index 448fb6c..0000000 --- a/docs/macos.md +++ /dev/null @@ -1,88 +0,0 @@ -# MacOS Setup - -Follow the steps below to configure the dotfiles on macOS. - -## Requirements - -### 1. Install Homebrew - -- [Homebrew](https://brew.sh/) - Package manager for macOS. - -After installing Homebrew, make sure to save its path somewhere using `which brew`. We are going to need it later to add it to path for `fish`. - -### 2. Install Fish - -```bash -brew install fish -which fish -``` - -For more info: - -- [Fish](https://fishshell.com/) - fish is a smart and user-friendly command line shell for Linux, macOS, and the rest of the family. - - -Here is a list of [Fish customizations](/docs/fish.md). - -#### Make fish the default shell - -```bash -chsh -s $(which fish) -``` - -### 3. Install iTerm2 - -```fish -brew install iTerm2 --cask -``` - -Setup iTerm2 from json file. [Download](./files/iterm-profile.json) - -### 4. Install Numi - -Calculator and conversion application. - -```fish -brew install numi --cask -``` - -### 5. Install Min browser - -Minimalist browser - -```fish -brew install min --cask -``` - -### 6. Install Karabiner-Elements - -Keybinding at system wide level for macOS. We want this for the sweet `ctrl+[` -> `esc` and `ctrl+h/j/k/l` -> `arrow keys`. - -```fish -brew install karabiner-elements --cask -``` - -### 7. Install Neovim - -Neovim is an extension of vim that supports Lua scripting for configurations and plugins. - -```fish -brew install neovim -``` - -After installing `neovim` check if the version is `>= 0.9.0`. -This is important because `treesitter` seems to be having problems with earlier versions. -As of now the stable version is `0.8.1` and it is causing problems. - - -If the version is not `>= 0.9.0`, follow these steps to install a compatible version: - -1. Download [nvim-macos.tar.gz](https://github.com/neovim/neovim/releases/download/nightly/nvim-macos.tar.gz). -2. Run `xattr -c ./nvim-macos.tar.gz` (to avoid "unknown developer" warning) -3. Extract: `tar xzvf nvim-macos.tar.gz` -4. Run `./nvim-macos/bin/nvim` - -Let's create a symlink to the binary file: -`sudo ln -s /path/where/it/is/located/bin/nvim /usr/local/bin/nvim`. This will allow us to run `nvim` without moving the binary to `usr/local/bin`. - -Now it is time to [setup Neovim](/docs/nvim.md). diff --git a/docs/nvim.md b/docs/nvim.md deleted file mode 100644 index 5a57d44..0000000 --- a/docs/nvim.md +++ /dev/null @@ -1,40 +0,0 @@ -# Setup Neovim - -> This section assumes you have cloned this repository. - -1. Create a symlink of the `nvim` folder: `ln -s /path/to/repository/nvim $HOME/.config/nvim`. -2. Replace `$HOME` with the full path to your home directory. -3. Open `packer.lua` that is inside `nvim/lua/juancwu`. -4. Run command `:so`, then run `:PackerSync` or `:PackerInstall`. - -Everything should be working. - -## Neovim plugins - -Here is a list of the plugins that I use: - -- [wbthomason/packer.nvim](https://github.com/wbthomason/packer.nvim) - Plugin Manager for Neovim >= 5.0 -- [VonHeikemen/lsp-zero](https://github.com/VonHeikemen/lsp-zero.nvim) - All in one, sweet, sweet LSP configurations. -- [nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim) - A blazing fast and easy to configure Neovim statusline written in Lua. -- [tjdevries/colorbuddy.nvim](https://github.com/tjdevries/colorbuddy.nvim) - A colourscheme helper for Neovim. -- [svrana/neosolarized.nvim](https://github.com/svrana/neosolarized.nvim) - A truecolour, solarized dark colourscheme using. -- [neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) - Configurations for Neovim builtin LSP server. -- [onsails/lspkind-nvim](https://github.com/onsails/lspkind.nvim) - vscode-like pictograms. -- [hrsh7th/nvim-cmp](https://github.com/hrsh7th/nvim-cmp) - A completion engine plugin for neovim written in Lua. - - [hrsh7th/cmp-buffer](https://github.com/hrsh7th/cmp-buffer) - nvim-cmp source for buffer words. - - hrsh7th/cmp-nvim-lsp - No link for this one, but it is needed -- [L3MON4D3/LuaSnip](https://github.com/L3MON4D3/LuaSnip) - Snippets for the LSP popups. -- [nvim-treesitter/nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) - Neovim treesitter for incremental syntax highlighting. -- [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs) - A super powerful autopair plugin for Neovim that supports multiple characters. -- [windwp/nvim-ts-autotag](https://github.com/windwp/nvim-ts-autotag) - Use treesitter to autoclose and autorename html tag. -- [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) - telescope.nvim is a highly extendable fuzzy finder over lists. Built on the latest awesome features from neovim core. -- [nvim-telescope/telescope-file-browser](https://github.com/nvim-telescope/telescope-file-browser.nvim) - telescope-file-browser.nvim is a file browser extension for telescope.nvim. It supports sunchronized creation, deletion, renaming, and moving of files and folders powered by telescope.nvim and plenary.nvim. -- [nvim-tree/nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) - A lua fork of vim-devicons. This plugin provides the same icons as well as colours for each icon. -- [iamcco/markdown-preview.nvim](https://github.com/iamcco/markdown-preview.nvim) - Markdown preview -- [akinsho/bufferline.nvim](https://github.com/akinsho/bufferline.nvim) - A snazzy buffer line. -- [norcalli/nvim-colorizer.lua](https://github.com/norcalli/nvim-colorizer.lua) - A high-performance colour highlighter for Neovim which has no external dependencies. -- [glepnir/lspsaga.nvim](https://github.com/glepnir/lspsaga.nvim) - A light-weight lsp plugin based on Neovim's builtin lsp with a highly performant UI. -- [ray-x/lsp_signature.nvim](https://github.com/ray-x/lsp_signature.nvim) - Show function signature when you type. -- [jose-elias-alvares/null-ls.nvim](https://github.com/ray-x/lsp_signature.nvim) - Use Neovim as a language server to inject LSP diagnostics, code actions, and more via Lua. -- [williamboman/mason.nvim](https://github.com/williamboman/mason.nvim) - Portable package manager for Neovim that runs everywhere Neovim runs. -- [williamboman/mason-lspconfig.nvim](https://github.com/williamboman/mason-lspconfig.nvim) - mason-lspconfig bridges mason.nvim with the lspconfig plugin.