openframeworks / openframeworks/openFrameworks

Automatically add emscripten examples to OF website ( curation help needed )

Open
#7,790 19 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

emscripten
Dominant language
C++
Stars
10.4k
Forks
2.6k
Avg merge
1d 21h
Merged PRs (30d)
9

Description

We now have a custom Github Action which builds examples listed and uploads them to the website.
at: https://openframeworks.cc/examples/

I have a few listed for now at:
https://github.com/openframeworks/openFrameworks/blob/master/scripts/ci/emscripten/examples_to_build.sh#L5-L21

But it would be great to add examples that work well on the web to the list.
cc: @Jonathhhan @artificiel @NickHardeman @dimitre

Feel free to PR to the script or just list examples in the format below.

eg:

    "examples/gl/shadowsExample"
    "examples/gl/materialPBR"
    "examples/gl/materialPBRAdvanced"
    "examples/gl/vboMeshDrawInstancedExample"

Next step will be to generate a nice index page.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read scripts/ci/emscripten/examples_to_build.sh and inspect the existing entries, then identify examples that work well in the web build. Add selected paths in the shown format and verify the custom action can build and upload them to the examples site. Done means a reviewed PR or a confirmed list of valid additions.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, github-actions, shell
Domain
build-system, web-dev
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.