diff --git a/ports/libsimpleservo/README.md b/ports/libsimpleservo/README.md index 76a5df4403943..8f4aec9b76782 100644 --- a/ports/libsimpleservo/README.md +++ b/ports/libsimpleservo/README.md @@ -1,3 +1,11 @@ +# libsimpleservo This is a basic wrapper around Servo. While libservo itself (/components/servo/) offers a lot of flexibility, libsimpleservo (/ports/libsimpleservo/) tries to make it easier to embed Servo, without much configuration needed. It is limited to only one view (no tabs, no multiple rendering area). + +## Building +Run the following command to generate `libsimpleservo` +``` +./mach build --release --libsimpleservo +``` +this will generate a shared library (`libsimpleservo.so` on linux) as well as a header file in `target/release` that you can then link to your application.