Skip to content

Commit 870d846

Browse files
authored
Quickstart for Devbox (#2525)
Summary How was it tested? Is this change backwards-compatible?
1 parent 1385a2b commit 870d846

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,43 @@
22

33
Devbox is a tool that lets you easily manage development environments.
44

5+
## Prerequisites
6+
* [Nix Package Manager](https://nixos.org/download.html) (Don't worry, you don't need to learn Nix)
7+
* [Docker](https://docs.docker.com/engine/install/)
8+
9+
## Quickstart
10+
11+
Initialize Devbox for your project
12+
```bash
13+
devbox init
14+
```
15+
16+
Add [Nix Packages](https://search.nixos.org/packages) to your project
17+
```bash
18+
devbox add goreleaser
19+
```
20+
21+
Start a local development shell with your project and packages
22+
```bash
23+
devbox shell
24+
```
25+
26+
Build a Docker image of your project
27+
```bash
28+
devbox build
29+
```
30+
## Language Support
31+
32+
Devbox can detect and automatically configure shells + Docker containers for your language.
33+
34+
To view the current plan for your project run:
35+
```bash
36+
devbox plan
37+
```
38+
Currently supported languages include:
39+
* Go
40+
41+
542
## Related Work
643

744
- [nix](https://nixos.org/)

0 commit comments

Comments
 (0)