Skip to content

Update README.md to remove some TODOs #67

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

Merged
dtig merged 1 commit into from
Jan 26, 2026
Merged

Update README.md to remove some TODOs #67

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,11 @@ See the Speedometer repo for a more detailed explanation, e.g., in which phases
- Prerequisites: NPM, node. `npm install` to install the dependencies of the runner.
- Building the individual workloads: Run `npm run build` in the root directory. This will install dependencies and build all workloads in `resources/`. Alternatively, you can also manually run `npm install` and `npm run build` inside each `resources/<workload-group>/` sub-directory to produce output in `resources/<workload-group>/dist/`.
- Starting the web server: `npm run dev` in the root directory.
- Running a workload in the browser: TODO.
- Inspecting and understanding metrics: TODO.
- Most important files:
- Workloads are in `resources/transformers-js/` and `resources/litert-js`.
- Shared files are in `resources/shared/`, which is depended-upon as a local package.
- The default suite / tests to run are in `resources/default-tests.mjs`.

TODO: Add a screenshot of the runner, after updating logo and name and some minor styling of the workloads.

## How to Run Individual Workload

- If you have not done that yet, run `npm install` and `npm run build` inside `resources/<workload-group>/` to produce output in `dist/`.
Expand Down