From dc3bcdf13435512cfa8799e040b932af2b8d34a0 Mon Sep 17 00:00:00 2001 From: David JENNI <3200210+davidjenni@users.noreply.github.com> Date: Thu, 25 Jan 2024 23:46:14 -0800 Subject: [PATCH] update readme: (#33) - unified setup for macOS/linux/WSL - added screenshots --- README.md | 27 +++++++++++++-------------- assets/mac-terminal.png | 3 +++ assets/win-terminal.png | 3 +++ bootstrap.ps1 | 2 +- bootstrap.sh | 2 +- 5 files changed, 21 insertions(+), 16 deletions(-) create mode 100644 assets/mac-terminal.png create mode 100644 assets/win-terminal.png diff --git a/README.md b/README.md index b5cabb4..a3b936a 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 -```` diff --git a/assets/mac-terminal.png b/assets/mac-terminal.png new file mode 100644 index 0000000..2311b67 --- /dev/null +++ b/assets/mac-terminal.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1fc6cafed7c2c11fb6e9ed2b88565f3038b2ea8272a3d5c4aa3af107ffa7f9d4 +size 243888 diff --git a/assets/win-terminal.png b/assets/win-terminal.png new file mode 100644 index 0000000..8c04fef --- /dev/null +++ b/assets/win-terminal.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8314f1e3deb34d3991b189ba485d83b09d5156da7afedebe3963ef9b180d8ede +size 115129 diff --git a/bootstrap.ps1 b/bootstrap.ps1 index 5eed9a9..4117c5e 100644 --- a/bootstrap.ps1 +++ b/bootstrap.ps1 @@ -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 diff --git a/bootstrap.sh b/bootstrap.sh index 90f4b43..afae94d 100755 --- a/bootstrap.sh +++ b/bootstrap.sh @@ -117,9 +117,9 @@ function installApps { helix less lsd + lua-language-server neofetch neovim - nvm ripgrep starship tmux