Skip to content

Commit

Permalink
Small documentation fixes & additions
Browse files Browse the repository at this point in the history
  • Loading branch information
Zubnix committed Jan 29, 2024
1 parent c3758e0 commit 16f7761
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
20 changes: 16 additions & 4 deletions docs/pages/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,13 @@ git clone https://github.com/udevbe/greenfield.git
Inside the `greenfield` repository, we'll use `yarn` to install all dependencies and build all packages.

{: .important }
>Greenfield requires [`yarn >=3.6`.](https://yarnpkg.com/getting-started/install)
> Greenfield works best with node.js 20 or greater. You can easily install it using [nvm](https://github.com/nvm-sh/nvm).
{: .important }
> Greenfield expects [yarn 3 or greater.](https://yarnpkg.com/getting-started/install)
{: .important }
> Greenfield requires the following packages to be installed on your build system: `autoconf libtool automake pipx ninja-build bison cmake build-essential gperf`.
```shell
yarn install
Expand Down Expand Up @@ -60,7 +66,7 @@ Greenfield provides a few examples that we can use.
We'll begin simple with `examples/webapps/simple-shm`.

```shell
yarn workspace @gfld/demo-webapp-simple-shm start
yarn workspace @gfld/example-webapp-simple-shm start
```

The Greenfield Compositor Shell maps the URL `web:simple-shm` to `http://localhost:9001`, which is the
Expand Down Expand Up @@ -90,7 +96,7 @@ Inside `examples/sdk/weston`
If all went well, a new `build/clients` directory has appeared with a bunch of `.html`, `.js` and `.wasm`. Spin up a web server so these can be served.

```shell
yarn workspace @gfld/weston-clients preview
yarn workspace @gfld/example-weston-clients preview
```

Enter any of these in the URL bar to see a WebAssembly desktop application.
Expand Down Expand Up @@ -123,14 +129,20 @@ yarn workspace @gfld/compositor-proxy build
```

{: .note }
> Building the native code requires CMake and Ninja. The build system will tell you what other packages might be missing.
> Building the native code requires the following dependencies :
> `libffi-dev libudev-dev libgbm-dev libdrm-dev libegl-dev libopengl-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libgstreamer-plugins-bad1.0-dev libgraphene-1.0-dev`.
{: .note }
> There's also a [Docker build script](https://github.com/udevbe/greenfield/blob/master/docker/compositor-proxy-cli-build.sh#L15) if you're unsure what dependencies you need.
The Compositor Proxy only provides a library to forward applications. We will also need an actual implementation that
can manage application lifecycles, provide some form of auth etc. A basic implementation is provided by Compositor Proxy CLI.

```shell
yarn workspace @gfld/compositor-proxy-cli start
```
{: .important }
> The Compositor Proxy works best with node.js 20 or greater. You can easily install it using [nvm](https://github.com/nvm-sh/nvm).
This will start the Compositor Proxy CLI locally on your machine with several applications pre-configured. The following
URLs are available.
Expand Down
5 changes: 4 additions & 1 deletion docs/pages/sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ Clone the repository if you haven't already.
git clone https://github.com/udevbe/greenfield.git
```

The SDK is located inside directory `sdk`. To use the SDK, we first need to build it.
The SDK is located inside directory `sdk`. To use the SDK, we first need to build it.

{: .important }
> Make sure all required Greenfield packages are installed. These are listed in [Greenfield Getting Started](/pages/getting_started)
```shell
./build_sysroot.sh
Expand Down

0 comments on commit 16f7761

Please sign in to comment.