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.

Sign up for GitHub

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

Jump to bottom

doc: how to run examples #475

Closed
wants to merge 1 commit into from
Closed

doc: how to run examples #475

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions rcdom/examples/README.md
View file
Open in desktop
@@ -0,0 +1,20 @@
# How to Run the Examples

In order to run the examples, you should clone the repo and its submodules:

```bash
git clone https://github.com/servo/html5ever.git
pushd ./html5ever/
git submodule update --init
```

Then run the examples, using the just name of the subdirectory that holds the examples you want to run.

For example:

```bash
# builds and runs ./rcdom/examples/
cargo run --example print-rcdom
```

This is a common convention among many projects.