docs: Cleanup README instructions

master
Sean McBride 3 years ago
parent 0fe40da3e5
commit f325c36183

@ -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). **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 ## Setting up a development environment
- 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.
### Native on Debian Host ### Native on Debian Host
1. Run `install_deb.sh` to install host dependencies ```sh
2. Run `make install` to clone submodules and build all components git clone https://github.com/gwsystems/sledge-serverless-framework.git
3. Run `make applications` to build all sample WebAssembly apps for execution on SLEdge cd sledge-serverless-framework
4. Run `make test` to execute end-to-end tests running WebAssembly apps on SLEdge. git checkout validate-setup
./install_deb.sh
source ~/.bashrc
make install
make applications
make test
```
### Docker ### Docker
**Note: These steps require Docker. Make sure you've got it installed!** **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. 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: To setup this environment, run:

Loading…
Cancel
Save