Skip to content

Commit

Permalink
Update description of dotfiles
Browse files Browse the repository at this point in the history
  • Loading branch information
erichlf committed Jun 4, 2024
1 parent d9e126a commit 1eed246
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ Develop your next Repo in a Devcontainer using *nvim* thanks to the
[Devconatiner CLI](https://github.com/devcontainers/cli) and this plugin
![devcontainer-cli in action](doc/gifs/nvim_devcontainer_cli-description.gif)

As you can see in the GIF above,
[alacritty](https://github.com/alacritty/alacritty) is being used as a Terminal
Emulator. Any of the ones recommended [here](https://www.lazyvim.org/) would
work. For dotfiles setup I would recommend looking at the `devcontainer` branch
of [my dotfiles](https://github.com/erichlf/dotfiles). The `install.sh` script is
quite simple, but should be very informative.
As you can see in the GIF above, guake with tmux is being used. Any of the ones
recommended [here](https://www.lazyvim.org/) would work. For dotfiles setup I created
a version of my dotfiles that doesn't have any private submodules. These dotfiles
are probably more than what anyone would want, but if feel free to use them. The
one gotcha with them is that it requires the environment variable DEV_WORKSPACE
to be set. I would recommend looking at the `devcontainer-cli` branch of
[my dotfiles](https://github.com/erichlf/dotfiles). The `install.sh` script ends
up calling `script/devcontainer-cli` which is quite simple, but should get you
some pretty good ideas of how things can be setup.

---

Expand Down Expand Up @@ -123,7 +126,7 @@ make assumptions about how you work.
local opts = {
-- whather to verify that the final devcontainer should be run
interactive = false,
-- search for the devcontainer directory closest to the root in the
-- search for the devcontainer directory closest to the root in the
-- directory tree
toplevel = true,
-- Remove existing container each time DevcontainerUp is executed
Expand Down

0 comments on commit 1eed246

Please sign in to comment.