Skip to content

Commit

Permalink
add a quick switch page for current developers
Browse files Browse the repository at this point in the history
  • Loading branch information
tomeichlersmith committed Aug 31, 2024
1 parent 3010d21 commit 939b004
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@

# Developing
- [Getting Started](developing/getting-started.md)
- [Quick Switch to denv and just](developing/quick-switch.md)
- [Building and Installing ldmx-sw](developing/building/intro.md)
- [Shared Computing Clusting](developing/building/clusters.md)
- [Updating ldmx-sw](developing/building/updating.md)
Expand Down
25 changes: 25 additions & 0 deletions src/developing/quick-switch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Quick Switch to `denv`+`just`

No frills, no explanations.

If anything goes wrong, fall back to the more full getting
started guides for [using](../using/getting-started.md) (for details on `denv`)
or [developing](getting-started.md) (for details on `just`).

This is targeted towards LDMX contributors who were present
before the transition to `denv`+`just` so they already have
a container runner present on their machine.

```sh
# install denv into ~/.local
curl -s https://raw.githubusercontent.com/tomeichlersmith/denv/main/install | sh
# install just into the same location
curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh |\
bash -s -- --to ~/.local/bin
# add just tab completion to your ~/.bashrc
printf '\neval "$(just --completions bash)"\n' >> ~/.bashrc
```

The `denv` install script attempts to help you update your `~/.bashrc`
so that `~/.local/bin` is in your `PATH` and discoverable by `bash` as
a program, but you may need to update your `PATH` manually.

0 comments on commit 939b004

Please sign in to comment.