Skip to content

Latest commit

 

History

History
executable file
·
50 lines (37 loc) · 2.28 KB

README.md

File metadata and controls

executable file
·
50 lines (37 loc) · 2.28 KB
Raw

Servo-experiments: A collection of experiments for Servo.

These demos aim to show off Servo's capabilities.

Running Servo

  • Follow the guide to run servo locally

Running experiment locally

After setting up servo locally, you can run follwing commands
./mach run -r -w [URL]
The -r specifies to use the version compiled for release and the -w enables WebRender.

To see FPS and other stats, run using
./mach run -w -r -- -Z wr-stats [URL]

Contributing to Servo-experiment

If you want to add an experiment to the repository, you are welcome to submit a PR. Or if you have an idea for experiment, please open an issue

Please follow this structure if you are planning to submit a PR:

Demos live in the experiments directory and are described in experiments.json.

An experiment should have its own folder in the experiments directory and should minimally contain:

  • index.html - entry point for the experiment
  • thumb.png - this file will be used as a screenshot of the demo for use on the homepage. It should be square and not too large.

The experiment should be described in experiments.json by a JSON object with the fields:

  • name - The name of the experiment.
  • desc - A short text description of the experiment.
  • href - The directory of the experiment e.g. experiments/foo.
  • long_description - A few lines explantion of your experiment and which feature of servo you are highlighting in your experiment

For example, for a new experiment super-cool-experiment:

  • experiments/super-cool-experiment/index.html is the entry point of the experiment.
  • experiments/super-cool-experiment/thumb.png is a square screenshot of the experiment in action, which is used to display the experiment on the homepage.

and the following JSON would be added to experiments.json:

 {
    "name": "Super Cool Experiment",
    "desc": "A super cool experiment which does interesting arbitrary things.",
    "href": "experiments/super-cool-experiment/",
    "long_description": "A super cool experiment which is using servo's xyz feature to xyz things..."
 }

Code of Conduct

Servo Code of Conduct is published at https://servo.org/coc/.