Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lsys/dotfiles
🚧🛠️ .files and setup configs - to help overcome my fear of setting up a new machine
https://github.com/lsys/dotfiles
bash dotfiles wsl
Last synced: 10 days ago
JSON representation
🚧🛠️ .files and setup configs - to help overcome my fear of setting up a new machine
- Host: GitHub
- URL: https://github.com/lsys/dotfiles
- Owner: LSYS
- Created: 2023-02-12T10:28:56.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-29T03:35:27.000Z (over 1 year ago)
- Last Synced: 2024-10-06T02:07:44.490Z (3 months ago)
- Topics: bash, dotfiles, wsl
- Language: Shell
- Homepage:
- Size: 529 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# My .files and setup configurations
# [Roadmap](#roadmap)
show/hide
> - [My key concerns/needs](#my-key-concernsneeds)
> - [Installation: Main Scripts](#installation-main-scripts)
> - [Installation: Order of Installation](#installation-order-of-installation-win)
> - [Additonal Details](#additional-details)
> - [References](#references)
## My key concerns/needs
* WSL
* Use package managers whenever possible (`apt`, `brew`, `winget`, `choco`, `npm`)
* Dotfiles are symlinked from this repo into `$HOME`
* (Mini)Conda, Jupyter, Python
* LaTeX + reveal-md for typesetting
* Bash with `Oh-My-Posh`
## Installation: Main Scripts
### Using the bootstrap script
The **`bootstrap`** file will take care of installing almost everything in my Linux subsystem. Just `cd` into the local folder of this repo and run `./bootstrap`. This `bootstrap` script calls the individual installers to set up the dotfiles, `bin/`, and package installers using `APT`, `Homebrew` (`Linuxbrew`), and `NPM`.
```shell
cd $HOME
git clone https://github.com/LSYS/dotfiles.git
cd dotfiles
./bootstrap
```
### Using the PowerShell scripts
The `PowerShell` scripts in `win/` will take care of installing Windows OS applications using `winget` and, to a smaller extent for applications that cannot be installed from `winget`, `Chocolatey`.
To install apps using `winget` and `Chocolatey`:
```PowerShell
cd win
./winget.ps1
./choco.ps1
```
## Installation: Order of Installation (Win)
1. Install `WSL`: Open `PowerShell` as administrator
```PowerShell
wsl --install -d Debian
# confirm that bash is running
which $SHELL
```
1. Install Native Windows apps: Open `PowerShell` (`./choco.ps1` need Admin)
```PowerShell
./winget.ps1
./choco.ps1
```
This will install `WindowsTerminal` and `Oh-My-Posh`. Type
```PowerShell
oh-my-posh font install
```
to install the fonts and choose Meslo (recommended). Seth the font in WindowTerminal setting (settings.json)
```json
{
"profiles":
{
"defaults":
{
"font":
{
"face": "MesloLGM NF"
}
}
}
}
```
3. Open WSL (`Debian`) in WindowsTerminal and run the `bootstrap` installer:
```bash
cd $HOME/dotfiles && ./bootstrap
```
This will call the following installers:
* `dotfiles.sh`
* `win/wslconfig.sh`
* `bin/install.sh`
* `packages/apt.sh`
* `packages/brew.sh`
* `packages/npm.sh`
* `monty/install.sh`
4. Once `Oh-My-Posh` is installed via `packages/brew.sh`. Check that it works
```bash
eval "$(oh-my-posh init bash)"
```
and symlink the poshthemes to home (where `bash/.bash_profile` will look for the themes)
```bash
cd $HOME && mkdir poshthemes && cd poshthemes
ln -s /home/linuxbrew/.linuxbrew/opt/oh-my-posh/themes/*
```
## Additional Details
### Bash
Will be installed in `./dotfiles.sh`.
```console
.
├── bash
│ ├── .aliases
│ ├── .bash_profile
│ ├── .exports
│ ├── .functions
│ └── .inputrc
```
* `.aliases`: Shell aliases defined here (including some for `Git`)
* `.bash_profile`: General bash settings (including `Oh-My-Posh` and sources other bash `dotfiles`)
* `.exports`: For `environment variables` (e.g., custom shell utilities and `conda` is specified here)
* `.functions`: For functions too big for `aliases` but too small for `bin/`
* `.inputrc`: Config for input (`case-insensitive completion` here)
(**Note:** `.bash_profile` is the first config that will be read by `bash`. So this file will source all other relevant dotfiles.)
### Git
Will be installed in `./dotfiles.sh`.
```Console
├── git
│ └── .gitconfig
```
`.gitconfig`: Includes `Git` aliases.
### Python + (Mini)Conda (`./monty/`)
Will be installed by `./monty/install.sh`.
```console
├── monty
│ ├── install.sh
│ ├── jupyter_notebook_config.py
│ └── requirements
│ ├── base.txt
│ ├── dev.txt
│ ├── docs.txt
│ └── gis.txt
```
* `jupyter_notebook_config.py`: Needed to make sure notebooks open in browser (native from Windows)
* `install.sh`: Installs Miniconda, Jupyter Notebook (and its extensions), installs base packages into base, creates `venv`(s) and installs the relevant packages into the `venv`(s).
### Packages
Will be installed by `packages/apt.sh`, `packages/brew.sh`, and `packages/npm.sh`.
```console
├── packages
│ ├── apt.sh
│ ├── brew.sh
│ └── npm.sh
```
* `apt.sh`: Installs utilities from `APT`.
* `brew.sh` Sets up and install `Linuxbrew`.
* `npm.sh`: Sets up `NVM` and `NPM`. Installs `reveal-md` (`reveal.js`) and other utilities only available from `NPM`.
### Windows
Will be installed by `win/winget.ps1` and `win/choco.ps1` (using PowerShell; `win/choco.ps1` will require admin priviledges).
```console
├── win
│ ├── .wslconfig
│ ├── .wslconfig-x1
│ ├── chocolatey.ps1
│ ├── terminal-settings.json
│ ├── winget.ps1
│ └── wslconfig.sh
```
* `winget.ps1`: Installs `winget` and follow up by installing other applications (e.g. Chrome, WindowsTerminal, Oh-My-Posh, GNUMake, PowerToys, 7zip, Slack, Sublime Text, Git etc.).
* `chocolatey.ps1`: Installs `Chocolatey` and other Windows app that cannot be installed by `winget` (e.g., MikTex, TexStudio, tree, postgresql, pgadmin4, du, etc.). This will require `PowerShell` admin priviledges.
* `wslconfig.sh`: Installs `.wslconfig` to `c/Users/`
### Miscellaneous (`./misc/`)
```console
├── misc
│ ├── img
│ ├── .curlrc
│ ├── .latexmkrc
│ ├── .wgetrc
│ ├── references.md
│ └── vimium.txt
```
## References
[See here.](https://github.com/LSYS/dotfiles/blob/main/misc/references.md)