Skip to content

Commit f75559c

Browse files
docs: update README.md
1 parent 4cfaa4d commit f75559c

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

README.md

+21-14
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Sets up a new development environment for a Mac or Linux (i.e., UNIX) box.
1212
* [mvp](#mvp)
1313
* [Summary](#summary)
1414
* [Setup](#setup)
15-
* [Quickstart](#quickstart)
15+
* [Minimum requirements](#minimum-requirements)
16+
* [Recommended requirements](#recommended-requirements)
1617
* [Development](#development)
1718
* [Makefile](#makefile)
1819
* [Taskfile](#taskfile)
@@ -21,7 +22,7 @@ Sets up a new development environment for a Mac or Linux (i.e., UNIX) box.
2122
* [Further Reading](#further-reading)
2223

2324
## Setup
24-
* Minimum requirements
25+
### Minimum requirements
2526
* [Python 3.11](https://www.python.org/downloads/)
2627
* Dev dependencies
2728
* make
@@ -30,12 +31,9 @@ Sets up a new development environment for a Mac or Linux (i.e., UNIX) box.
3031
* [editorconfig](https://editorconfig.org/)
3132
* [wsl](https://docs.microsoft.com/en-us/windows/wsl/setup/environment)
3233

33-
## Quickstart
34-
* Install python and tooling
35-
```bash
36-
# install python and dependencies (e.g., git, ansible, etc.)
37-
./bootstrap install
38-
```
34+
### Recommended requirements
35+
* [devbox](https://www.jetpack.io/devbox/docs/quickstart/)
36+
* [task](https://taskfile.dev/#/installation)
3937

4038
## Development
4139
### Makefile
@@ -72,20 +70,29 @@ task: Available tasks for this project:
7270
```
7371

7472
### Devbox
75-
I.e., [Nix Package Manager](https://search.nixos.org/packages)
73+
Devbox takes care of setting up a dev environment automatically. Under the hood it uses [Nix Package Manager](https://search.nixos.org/packages).
74+
75+
Currently, it supports the following:
76+
* [asdf](https://asdf-vm.com/guide/getting-started.html#_2-download-asdf)
77+
* [docker](https://docs.docker.com/compose/install/)
78+
* [gh](https://cli.github.com/manual/)
79+
* [minikube](https://minikube.sigs.k8s.io/docs/start/)
80+
* [nodejs (21.4)](https://nodejs.org/en/download/)
81+
* [poetry](https://python-poetry.org/docs/)
82+
* [python (3.11)](https://www.python.org/)
83+
* [task](https://taskfile.dev/#/installation)
84+
* [tilt](https://docs.tilt.dev/install.html)
85+
7686
```bash
7787
# enter dev environment
7888
devbox shell
7989

80-
# run individual app
81-
python <sign_jwt|meetup_query|slackbot|main>.py
90+
# run repl
91+
python
8292

8393
# exit dev environment
8494
exit
8595

86-
# run standalone server
87-
devbox run start
88-
8996
# run tests
9097
devbox run test
9198
```

0 commit comments

Comments
 (0)