Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix typos and clarify verification step #82

Merged
merged 1 commit into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ subdirectory for further information the SDK provides but the guide below will c
Add the following to your shell configuration file (e.g. `~/.bashrc`, `~/.zprofile`, ...)
to ensure that the `${WKDEV_SDK}` environment variable points to the correct location
of your `webkit-container-sdk` Git checkout. It also extends the `${PATH}` to make the `wkdev-*` scripts
provided by this repository accessible without having to specifcy full paths in the shell.
provided by this repository accessible without having to specify full paths in the shell.

```sh
source /absolute/path/to/your/Git/checkout/of/webkit-container-sdk/register-sdk-on-host.sh
```

Launch a new shell, or `source` your shell configuration files to verify, `${WKDEV_SDK}`
now expects as intented - pointing to your `webkit-container-sdk` checkout.
Launch a new shell, or `source` your shell configuration files, to verify `${WKDEV_SDK}`
now works as intended -- pointing to your `webkit-container-sdk` checkout.

2. Create a new **wkdev** container for WebKit development

Expand All @@ -36,7 +36,7 @@ wkdev-create --create-home
```

This will create a container named **wkdev** by default or a custom one with `--name`
and it will create a new home directory for the sdk in `${HOME}/wkdev-home` by default
and it will create a new home directory for the SDK in `${HOME}/wkdev-home` by default
or a custom one with `--home`.

Within the container, the `${HOME}` directory is not equal to the host `${HOME}` directory:
Expand Down
8 changes: 4 additions & 4 deletions docs/00-Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ run commands within the **wkdev** container or launch one or more interactive sh
sessions, in which you can compile WebKit / run tests / etc.

To run CLI applications within a container, requires no effort: it works out of the box.
Runing graphical applications, that utilize e.g. [Wayland](https://wayland.freedesktop.org)
Running graphical applications, that utilize e.g. [Wayland](https://wayland.freedesktop.org)
for screen presentation, need [D-Bus](https://freedesktop.org/wiki/Software/dbus) to communicate
with other system components, or use [SystemD](https://freedesktop.org/wiki/Software/systemd)
APIs to query network / power / etc. information, require a substantial amount of configuration
Expand Down Expand Up @@ -63,14 +63,14 @@ Let it run, and move on to the **Quickstart guide**.
Add the following to your shell configuration file (e.g. `~/.bashrc`, `~/.zprofile`, ...)
to ensure that the `${WKDEV_SDK}` environment variable points to the correct location
of your `wkdev-sdk` Git checkout. It also extends the `${PATH}` to make the `wkdev-*` scripts
provided by this repository accessible without having to specifcy full paths in the shell.
provided by this repository accessible without having to specify full paths in the shell.

```sh
source /absolute/path/to/your/Git/checkout/of/wkdev-sdk/register-sdk-on-host.sh
```

Launch a new shell, or `source` your shell configuration files to verify, `${WKDEV_SDK}`
now expects as intented - pointing to your `wkdev-sdk` checkout.
Launch a new shell, or `source` your shell configuration files, to verify `${WKDEV_SDK}`
now works as intended -- pointing to your `webkit-container-sdk` checkout.

2. Create a new **wkdev** container for WebKit development

Expand Down
2 changes: 1 addition & 1 deletion docs/04-Cross-compilation-inside-the-SDK.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ Tools/Scripts/cross-toolchain-helper --cross-target rpi3-32bits-mesa --cross-too
It is important to unset the `LD_LIBRARY_PATH` otherwise `cross-toolchain-helper` will partly fail,
but `build-webkit` continues, leading to an inconsistent build environment, that will fail to produce binaries.

sccache is also not supported in that mode, and will interefer with yocto - disable it.
sccache is also not supported in that mode, and will interfere with yocto -- disable it.

Follow the instructions in Tools/yocto/README.md to flash the image onto your target machine.
Loading