Skip to content

Commit

Permalink
update readme: (#33)
Browse files Browse the repository at this point in the history
- unified setup for macOS/linux/WSL
- added screenshots
  • Loading branch information
davidjenni authored Jan 26, 2024
1 parent 4ae152f commit dc3bcdf
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 16 deletions.
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
# dot files

DotFiles for my macOS, Win32 & Linux environments. Geared towards use of git and vim.
DotFiles for my macOS, Win32 & Linux environments. Geared towards use of git and neovim.

## Bootstrap
[![PullRequest](https://github.com/davidjenni/dotfiles/actions/workflows/PR.yml/badge.svg)](https://github.com/davidjenni/dotfiles/actions/workflows/PR.yml)

## Screenshots

macOS
![macOS alacritty terminal](assets/mac-terminal.png)

Win11
![Windows terminal](assets/win-terminal.png)

## Installation

### Windows 10/11

Expand All @@ -13,21 +23,10 @@ Set-ExecutionPolicy RemoteSigned -Scope CurrentUser -Force
irm 'https://raw.githubusercontent.com/davidjenni/dotfiles/main/bootstrap.ps1' | iex
````

### macOS
### macOS 14+/Ubuntu 22+ (WSL or VM)

to bootstrap, run this in a default Terminal.app prompt:

````shell
curl -fsSL https://raw.githubusercontent.com/davidjenni/dotfiles/main/bootstrap.sh | bash
````

### Linux (Ubuntu/Debian)

NOTE: WIP, bootstrap doesn't work reliably in Debian(bookworm) nor Ubuntu 22 yet,
still missing apps!

* open terminal/WSL:

````shell
curl -fsSL https://raw.githubusercontent.com/davidjenni/dotfiles/main/bootstrap.sh | bash
````
3 changes: 3 additions & 0 deletions assets/mac-terminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions assets/win-terminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion bootstrap.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ function copyFile {

function installScoopApps {
Write-Host "Installing apps via scoop..."
& scoop install 7zip bat delta dust fd fzf helix less lsd neovim nuget nvm ripgrep starship tre-command tokei zig zoxide
& scoop install 7zip bat delta dust fd fzf helix less lsd lua-language-server neovim nuget nvm ripgrep starship tre-command tokei zig zoxide
& scoop bucket add nerd-fonts
& scoop install hack-nf-mono hack-nf JetBrainsMono-NF JetBrainsMono-NF-mono
& scoop bucket add extras
Expand Down
2 changes: 1 addition & 1 deletion bootstrap.sh
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@ function installApps {
helix
less
lsd
lua-language-server
neofetch
neovim
nvm
ripgrep
starship
tmux
Expand Down

0 comments on commit dc3bcdf

Please sign in to comment.