Skip to content

Commit 8d387fc

Browse files
authored
doc: update readme (#192)
1 parent 97d7713 commit 8d387fc

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ To update this installation, run `devenv update`.
3434

3535
This is intended for initial setup of a new machine.
3636

37-
3837
`devenv fetch [repository name]`
3938

4039
Any repository on github in the form of `[org]/[reponame]`
@@ -58,22 +57,32 @@ In general, our library is designed to isolate, as much as possible, a repo's de
5857
For example, [gcloud](#gcloud) is installed to `[reporoot]/.devenv/bin/gcloud` (with the gcloud sdk at `[reporoot]/.devenv/bin/google-cloud-sdk`).
5958
An exception to this would be python virtualenvs, which was implemented before the idea of `[reporoot]/.devenv`.
6059

61-
6260
`devenv doctor`
6361

6462
Use this to diagnose and fix common issues.
6563

6664
Repo-specific checks and fixes can be defined in `[reporoot]/devenv/checks`.
6765
Otherwise we have "builtin" checks and fixes in `devenv.checks`.
6866

67+
`devenv update`
68+
69+
This updates the global devenv installation, and global tools.
70+
71+
If you're upgrading from a particularly old devenv, it won't have `update` so you need to:
72+
`~/.local/share/sentry-devenv/venv/bin/pip install -U sentry-devenv`
73+
6974

7075
## technical overview
7176

7277
Everything devenv needs is in `~/.local/share/sentry-devenv`.
7378

74-
- `~/.local/share/sentry-devenv/bin` contains `devenv` and `direnv`
75-
- we currently rely on a minimal [`[reporoot]/.envrc`](#direnv) to add `[reporoot]/.devenv/bin` to PATH
76-
- see [examples](#examples) for .envrc suggestions
79+
- `~/.local/share/sentry-devenv/bin` contains:
80+
- `devenv` itself
81+
- `direnv`
82+
- we currently rely on direnv and a minimal [`[reporoot]/.envrc`](#direnv) to add `[reporoot]/.devenv/bin` to PATH
83+
- see [examples](#examples) for .envrc suggestions
84+
- global tools: `docker` (cli), `colima`
85+
7786

7887
### runtime
7988

0 commit comments

Comments
 (0)