diff --git a/README.md b/README.md index fcc6192ad..6d9f81a51 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@

discord invitation link continuous integration +trackgit-views

envd is a development environment management tool for data scientists. @@ -28,9 +29,7 @@ envd is a development environment management tool for data scientists. ### From binary -```bash -sudo /bin/sh -c 'wget https://github.com/tensorchord/envd/releases/download/0.0.1-alpha.5/envd_0.0.1-alpha.5_Linux_x86_64 -O /usr/local/bin/envd && chmod +x /usr/local/bin/envd && /usr/local/bin/envd bootstrap' -``` +TODO ### From source code @@ -60,9 +59,12 @@ shell("zsh") jupyter(password="", port=8888) ``` -Then you can run `envd up` and open jupyter notebook at [`http://localhost:8888`](http://localhost:8888), or open vscode remote to attach to the container. +Then you can run `envd up` to create the development environment. + +TODO: illustrate that the cache will be persistent. ``` +$ envd up [+] ⌚ parse build.envd and download/cache dependencies 0.0s ✅ (finished) => 💽 (cached) download oh-my-zsh 0.0s => 💽 (cached) download ms-python.python 0.0s @@ -82,13 +84,24 @@ Then you can run `envd up` and open jupyter notebook at [`http://localhost:8888` => 💽 (cached) install oh-my-zsh 0.0s ... # You are in the docker container for dev -envd > +(envd 🐳) ➜ mnist-dev git:(master) python3 ./main.py +... +``` + +Jupyter notebook service and sshd server are running inside the container. You can use jupyter or vscode remote-ssh extension to develop AI/ML models. + +``` +$ envd ls +NAME JUPYTER SSH TARGET GPU STATUS CONTAINER ID +mnist http://localhost:8888 mnist.envd true running 253f656b8c40 ``` ## Features ### Configure mirrors +envd supports PyPI mirror and apt source configuration. You can configure them in `build.env` or `$HOME/.config/envd/config.envd` to set up in all environments. + ```text cat ~/.config/envd/config.envd ubuntu_apt(source=""" @@ -109,8 +122,6 @@ vscode(plugins = [ ]) ``` -envd configures Ubuntu APT source, PyPI mirror, and others in the development environment. - ## Join Us envd is backed by [TensorChord](https://github.com/tensorchord) and licensed under Apache-2.0. We are actively hiring engineers to build developer tools for machine learning practitioners in open source.