Skip to content

Conversation

johnstcn
Copy link
Member

Fixes #164

@johnstcn johnstcn requested review from mafredri and mtojek September 10, 2024 11:58
@johnstcn johnstcn self-assigned this Sep 10, 2024
README.md Outdated
docker run -it --rm -e ENVBUILDER_INIT_SCRIPT='/usr/games/cowsay "happy hacking"' -v $PWD:/workspaces/empty ghcr.io/coder/envbuilder:latest
```

If your `devcontainer.json` is not present in the root of the workspace folder,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

root or .devcontainer dir.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated.

If you don't have a remote Git repo or you want to quickly iterate with some
local files, simply omit `ENVBUILDER_GIT_URL` and instead mount the directory
containing your code to `/workspaces/empty` inside the Envbuilder container.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is empty a magic name here? Or does any name work?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to also mention ENVBUILDER_WORKSPACE_FOLDER.

Copy link
Member

@mtojek mtojek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

PS. I have a feeling we need a regular/static docs page for this project.

@johnstcn
Copy link
Member Author

I have a feeling we need a regular/static docs page for this project.

Agreed, we could probably start with a simple GitHub pages setup.

@johnstcn johnstcn merged commit 9b83cf5 into main Sep 10, 2024
4 checks passed
@johnstcn johnstcn deleted the cj/docs/local-quickstart branch September 10, 2024 13:38
mafredri pushed a commit that referenced this pull request Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

update docs with example for local-only usage

3 participants