From f325c361830bef95f13ac28f82c9075c85a9d5d7 Mon Sep 17 00:00:00 2001 From: Sean McBride Date: Wed, 2 Mar 2022 12:59:47 -0500 Subject: [PATCH] docs: Cleanup README instructions --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 246ff44..e5c8671 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,27 @@ **SLEdge** is a lightweight serverless solution suitable for edge computing. It builds on WebAssembly sandboxing provided by the [aWsm compiler](https://github.com/gwsystems/aWsm). -## Host Dependencies - -- Docker - [Installation Instructions](https://docs.docker.com/install/) - -## Setting up the environment - -You may either build the application natively on your host or in a Docker environment. +## Setting up a development environment ### Native on Debian Host -1. Run `install_deb.sh` to install host dependencies -2. Run `make install` to clone submodules and build all components -3. Run `make applications` to build all sample WebAssembly apps for execution on SLEdge -4. Run `make test` to execute end-to-end tests running WebAssembly apps on SLEdge. +```sh +git clone https://github.com/gwsystems/sledge-serverless-framework.git +cd sledge-serverless-framework +git checkout validate-setup +./install_deb.sh +source ~/.bashrc +make install +make applications +make test +``` ### Docker **Note: These steps require Docker. Make sure you've got it installed!** +[Docker Installation Instructions](https://docs.docker.com/install/) + We provide a Docker build environment configured with the dependencies and toolchain needed to build the SLEdge runtime and serverless functions. To setup this environment, run: