diff --git a/README.md b/README.md index 484c170be..063e7fa7e 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,10 @@ From time to time, we also publish some videos for new Livebook releases: We provide several distinct methods of running Livebook, pick the one that best fits your use case. -You will need [Elixir v1.12](https://elixir-lang.org/install.html) or later. +### Running locally + +You can run Livebook on your own machine. You will need +[Elixir v1.12](https://elixir-lang.org/install.html) or later. Livebook also requires the following Erlang applications: `inets`, `os_mon`, `runtime_tools`, and `ssl`. Those applications come with most Erlang distributions but certain package managers may split @@ -50,7 +53,7 @@ be installed as follows: sudo apt install erlang-inets erlang-os-mon erlang-runtime-tools erlang-ssl ``` -### Escript +#### Escript Running Livebook using Escript makes for a very convenient option for local usage and provides easy configuration via CLI options. @@ -77,7 +80,7 @@ install the escript directly from GitHub like this: mix escript.install github livebook-dev/livebook ``` -### Docker +#### Docker Running Livebook using Docker is a great option for cloud deployments and also for local usage in case you don't have Elixir installed. @@ -101,7 +104,7 @@ To try out features from the main branch you can alternatively use the `livebook/livebook:edge` image. See [Livebook on Docker Hub](https://hub.docker.com/r/livebook/livebook/tags?page=1&ordering=last_updated). -### Mix +#### Mix You can run latest Livebook directly with Mix. @@ -179,6 +182,12 @@ MIX_ENV=prod mix escript.build ./livebook server ``` +## Sponsors + +Livebook development is sponsored by: + + + ## License Copyright (C) 2021 Dashbit