Skip to content

Commit

Permalink
Add better docs, improve ux
Browse files Browse the repository at this point in the history
  • Loading branch information
dhvcc committed Jul 2, 2024
1 parent b314679 commit f68185a
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 6 deletions.
7 changes: 7 additions & 0 deletions .cfg/setup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ fi
./.cfg/scripts/install-brew.sh
./.cfg/scripts/install-packages.sh

pip3 install pipx
pipx install poetry --include-deps
pipx install ansible --include-deps
pipx install git+https://github.com/politeauthority/docker-pretty-ps.git#egg=docker-pretty-ps
pipx install ranger-fm --include-deps
pipx install ipython --include-deps

export NVM_DIR="$HOME/.nvm"
[ -s "/home/linuxbrew/.linuxbrew/opt/nvm/nvm.sh" ] && \. "/home/linuxbrew/.linuxbrew/opt/nvm/nvm.sh" # This loads nvm
nvm install 16
Expand Down
2 changes: 1 addition & 1 deletion .config/.aliasrc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ alias ls="lsd -A --group-dirs first --color $color_lsd" \
[ $(infocmp >/dev/null 2>&1) ] && alias ssh="kitty +kitten ssh"

docker() {
if [[ $1 == "ps" && -n "$(command docker-pretty-ps)" ]]; then
if [[ $1 == "pps" && -n "$(command docker-pretty-ps)" ]]; then
shift # remove the first "ps" argument from argv
command docker-pretty-ps $@
else
Expand Down
2 changes: 1 addition & 1 deletion .zshrc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ path+=(
)

# Util configs
export FZF_DEFAULT_COMMAND='rg --files --follow --no-ignore-vcs --hidden'
export FZF_DEFAULT_COMMAND='rg --files --follow --respect-gitignore --hidden --glob "!**/.venv/**" --glob "!**/venv/**" --glob "!**/node_modules/**" '
export BAT_THEME="Nord"

# Starship prompt initialization
Expand Down
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,23 @@ For GNOME desktop setup see [this repo](https://github.com/dhvcc/desktop).

![desktop](https://user-images.githubusercontent.com/18076967/186787936-8ff80282-5e4e-4643-b1cd-4f3ac0a6d140.png)

## Install
## Quick Install

While installing, some files may conflict with the ones being pulled from this repo. Before retrying, remove `"$HOME"/.cfg` directory
**Prerequisites are only `bash` / `curl` / `git` (macOS should have them installed by default, although git would need user input to install after prompt)**


This will move every conflicting file from home into ~/.config-backup directory, so you can return to backup if needed

```shell
curl -Lks https://raw.githubusercontent.com/dhvcc/configs/master/.cfg/install.sh | /bin/sh
exec bash
```

You may want to add
`0 0 * * * cfg pull --rebase` as a cron job (`crontab -e`)
This will run the setup for all of the utils that you need to run this config

```shell
"$HOME/.cfg/setup.sh"
```

**Warning**, Bash configs may be outdated, use `zsh` as your default

Expand All @@ -27,6 +34,20 @@ You may want to add
- `neofetch` can be turned off with `NEOFETCH=0` (in something like `.config/.rc_extend.sh`)
- you can override default neofetch settings with your own theme. Just add `export NEOFETCH_THEME=name_of_your_theme` to `.rc_extend.sh` and add your settings into `~/.config/neofetch/themes/name_of_your_theme.sh` file

----------------

# Sections below will be re-written because of the new installer

----------------

## TODO
- Don't default editor to VIM
- Fix aliases when command is not found (ls/vim)
- Better extensibility support (redo .rc_extend.sh and friends)
- Better docs
- Revert config script
- Helper command (something like cfg help?)

## Dependencies

### System
Expand Down

0 comments on commit f68185a

Please sign in to comment.