Update README with usage details#15
Draft
Subramanian-K812 wants to merge 23 commits into
Draft
Conversation
PiotrKorkus
reviewed
Jun 1, 2026
PiotrKorkus
left a comment
PiotrKorkus
left a comment
Collaborator
There was a problem hiding this comment.
MVP for me:
- prerequisites to install
- how to run showcases on host docker and qemu
- how to build and run showcases on RPi (I will add aarch config in the meanwhile)
then the rest thats currently there
PiotrKorkus
reviewed
Jun 1, 2026
| Intention for each folder is described below | ||
| ```bash | ||
| sudo apt-get update | ||
| sudo apt-get install -y protobuf-compiler libclang-18-dev lcov docker.io qemu-system-x86 |
Collaborator
There was a problem hiding this comment.
E: Unable to locate package libclang-18-dev
| Intention for each folder is described below | ||
| ```bash | ||
| sudo apt-get update | ||
| sudo apt-get install -y protobuf-compiler libclang-18-dev lcov docker.io qemu-system-x86 |
Collaborator
There was a problem hiding this comment.
thats not how you install docker - https://docs.docker.com/engine/install/ubuntu/
Author
There was a problem hiding this comment.
Have provided the link for docker installation
|
|
||
| To generate a full documentation of all integrated modules, run: | ||
| Notes: | ||
| - Use `--config=<name>` to select the correct toolchain/platform (common configs: `linux-x86_64`, `qnx-x86_64`, `eb-aarch64`, `autosd-x86_64`). See `.bazelrc` for all available configs. |
Collaborator
There was a problem hiding this comment.
tests are supporting only linux and qnx currently
PiotrKorkus
reviewed
Jun 2, 2026
Comment on lines
135
to
139
| 4. **Run a specific showcase** by following the CLI prompts, or invoke a binary directly. For example, to run the communication example (from [`showcases/standalone/com.score.json`](showcases/standalone/com.score.json)): | ||
|
|
||
| ```bash | ||
| gita clone --preserve-path --from-file .gita-workspace.csv | ||
| /showcases/bin/ipc_bridge_cpp -n 10 -t 100 -m send | ||
| ``` |
Collaborator
There was a problem hiding this comment.
communication is wrong example as it requires two processes send and receive. Use a lifecycle.
…eclipse-score#235) * bazel config for AutoSD x86 build fixed. * AutoSD menu entry in score_starter renamed to Docker instead of QEMU.
…clipse-score#230) * improve ref integration documentation * Fix CI: write quality reports to docs/verification_report The path docs/s_core_v_1/verification did not exist and was not created, causing the unit-test/coverage script to crash with FileNotFoundError. Use the existing docs/verification_report directory (and create it if missing) for both the script output and the workflow summary step. * docs: add missing pages to root toctree Sphinx (warnings-as-errors) failed because docs/s_core_v_1/index.rst and docs/verification_report/platform_verification_report.rst were referenced via grid-cards but not listed in any toctree. * docs(roadmap): refresh overall_status against pinned score ref - Repin score from 5b8a1e34 to 1b51518e (81 source-link URLs) - Baselibs PA3 Component Architecture: 164/166 -> 165/167 skill(overall-status): clean up and fix checklist counter - Restructure SKILL.md (1063 -> 517 lines): drop migration notes, duplicated callouts, and the empty 'Complete RST Snapshot' section. - Specify counting model in plain prose (no formulas). - Fix count_checklist_status: chklst_*.rst stores :status: indented inside the .. document:: block, not at column 0. Updated section 3.3 and the Step-2 helper accordingly. * docs(roadmap): add per-PA release-progress SVG figures and document generation in SKILL - Add docs/_assets/pa{2,3,4,5}_*.svg charts showing release evolution (v0.5.0-beta -> v0.6.0 -> v0.7.0 -> current main) above each PA module-tracker table in overall_status.rst. - Embed via .. figure:: directives with alt text and width. - Extend .github/skills/overall-status/SKILL.md (sec. 6a) with: - release pinning recipe (annotated-tag deref, known_good schema diffs, 'now' = known_good.json on main of reference_integration) - per-chart metric table and SVG generation workflow - Communication vs. Some/IP double-count guard (applies to all PAs) - rule that charts use TOTAL directive count, not valid-only - PA5 split: historical bars from TEST-macro regex, 'now' bar from PA5 RST table column sums; documented divergences. * docs(overall_status): refine PA1/PA5 layout, add platform-ver admonition, fix label warnings - PA1: render FR issue titles next to the issue number; restrict #549 to Baselibs; add #757 'qualified json-parser' to Baselibs (no milestone); drop #914/#917 from Communication (local IPC scope only) - PA5: drop per-module Platform Ver. Rpt column; add prominent Platform Verification Report admonition after the table - PA5: split test counts onto a separate line-block line below the status emoji - PA5: add reader notes for C0/C1 coverage source and Static/Dynamic analysis semantics - Add cross-reference labels (overall_status_pa2..pa5) to fix six Sphinx 'undefined label' warnings from pi1/pi2/pi3 - custom.css: neutralise blockquote/line-block styling inside list tables so secondary lines blend into the cell; style new .platform-ver-report admonition Sphinx build now reports 0 warnings, 0 errors. SKILL.md updated to document all of the above (sections 4.0, 4.2, 5.0, 5.1, 5.2). * docs: mark overall_status as AI-generated and indicative * docs(overall_status): enlarge status headings and add rollout progress bar - Style 'Process Status' rubrics with new .status-heading class for larger, bolder appearance. - Replace 'Implementation status: ...' rubrics with an inline 'Rollout status' row containing label, percentage, progress bar and detail text in one line. - Add corresponding CSS in docs/_assets/custom.css (.status-heading, .impl-status-row and .impl-status-bar/.impl-status-fill). * docs(roadmap): add Planning Approach page - New planning_approach.rst summarising how v1.0 is planned: GitHub project, Product Increment tickets per Feature Team / Community mapped to milestones, sub-tickets and the GitHub project's process area attribute for grouping. - Link to the authoritative Platform Management Plan as primary reference. - Add the page to the roadmap toctree (after Overall Status). * docs(roadmap): refine PI1 work breakdown for Release Gate v0.8 - Clarify automation checks are part of docs-as-code toolchain (//:docs) - Add CI/CD workflow item for requirement/architecture validation - Add inspection checklist completion item with team and process area - Add Module Verification Report completion item (pa5_verification) - Add outstanding implementation tickets item (pa4_impl) - Replace 'component' attribute references with 'team' - Remove Feasibility Check section * docs(pi1): expand v0.8 work breakdown with TL-circle review and unified Bazel targets * docs(roadmap): add platform/toolchain bullet, ref-int integration item, and Terminology section * Address SKILL.md review findings (PR eclipse-score#230) - Fix --paginate being embedded in URL string; pass it as a real CLI flag - Renumber duplicate ### 5.4 (Rollout status row) to ### 5.5 - Fix stray 'e|' prefix on the PA5 Static Analysis row - Add overall_status_pa1 to the required-labels list (§5.0) - Clarify in §3.4 that the per-cell LOC uses the §6a.2 byte÷30 method - Document why the Time keyword in KW_FALLBACK has a leading space * Add overall_status_pa1 anchor to overall_status.rst (PR eclipse-score#230) Matches the PA2-PA5 pattern so :ref:`overall_status_pa1` from PI pages resolves without warnings. * Fix four obvious bugs from PR eclipse-score#230 review (eclipse-score#256) * Fix four obvious bugs found in review of PR eclipse-score#230 - SKILL.md §6 Step 6: stale §5.4 cross-reference updated to §5.5 after the Rollout status heading was renumbered (§5.4 is now Pie chart row) - SKILL.md comp_req_cell(): trlc=True with both counts zero returned "✅ Available (0/0 comp_req [TRLC])" instead of "❌ Open" because the zero-guard only fired when parts was empty, but trlc forced a part entry; fix: check ct==0 and at==0 unconditionally before building parts - SKILL.md §6a.2: count_directives() was referenced but never defined; replaced with count_directives_with_status(...)[1] - quality_runners.py: zip() paired unit-test and coverage dicts by position, silently dropping rust coverage exit codes beyond the first module; replaced with a flat check over the merged dict * style: collapse any() to single line to satisfy ruff * Address remaining PR eclipse-score#230 review findings - §1: clarify NM and Diagnostic Services are PA1-only (no own repo, no known_good.json key); their PA2-PA5 cells render ❌ Open by design and they contribute 0 to the per-PA progress charts. - §2: cross-reference note explaining why no rows exist for them and what to do once their repos are created. - §4 PA5: drop the orphaned 5th pipe column on the Static Analysis row (silently dropped by Markdown renderers); promote the no-link discipline note to a blockquote below the table covering both Static and Dynamic Analysis. * Roadmap: add Safety Analysis and Safety Management to Qualifiable State Addresses PR eclipse-score#230 review comments by @aschemmel-tech and @masc2023: - Add **Safety Analysis** to the mandatory process areas list — it is already highlighted (blue) in the Development grid below, the prose list was inconsistent. - Add **Safety Management** to the mandatory list and switch its Management-grid card from card-pa-grey to card-pa-highlight. Safety Management produces the safety manuals and the safety (release) package required for qualification, so it is a mandatory condition for the Qualifiable State. - Add a short rationale paragraph explaining why both PAs are mandatory. --------- Co-authored-by: Alexander Lanin <Alexander.Lanin@etas.com>
…score#257) * Fix duplicate releases listing and add data collection date - Remove redundant docs/s_core_v_1/releases/index.rst which was picked up by the glob toctree in releases.rst, causing release notes to appear twice on the Releases page. - Add a highlighted 'Data collected on' note at the top of overall_status.rst so readers know the snapshot date. * Document data collection date update in overall-status SKILL Step 6 now explicitly requires bumping the 'Data collected on' admonition at the top of overall_status.rst on every regeneration.
…ore#248) (eclipse-score#258) * fix: mount Docker socket in devcontainer to fix bazel run Fixes eclipse-score#248 When running inside the devcontainer, the generated run_docker.sh script calls and . These fail because the host Docker socket (/var/run/docker.sock) was not mounted into the container, resulting in: failed to connect to the docker API at unix:///var/run/docker.sock; dial unix /var/run/docker.sock: connect: no such file or directory Add a bind mount for the Docker socket in .devcontainer/devcontainer.json so that Docker commands inside the devcontainer communicate with the host Docker daemon. * Fix Formatting --------- Co-authored-by: akshaylg0314 <akshay14.garg@lge.com>
… status (eclipse-score#261) * Refactor overall-status skill into agent + per-PA references Split the monolithic overall-status SKILL.md into a slim index plus a Common engine and one reference file per Process Area (PA1-PA5), and add the overall-status agent that orchestrates the refresh procedure. * Refresh overall status: repin score links, bump date Re-point the 86 eclipse-score/score source links from the stale pin 5b8a1e34 to the current known_good pin 1b51518e, update Baselibs Component Arch count (164/166 -> 165/167) for the new comp_arc directive in the result component, and bump the data collection date to 2026-06-12.
Add step-by-step integration process documentation including module addition, documentation, unit tests, platforms, component tests, integration tests, reporting, and code quality steps, plus a checklist and reference.
) * ci: enable cr_checker copyright check via pre-commit hook * fix: add copyright headers to files missing SPDX block * fix: add missing copyright header to overall_status.rst * fix: remove broken copyright_checker Bazel target * fix: add missing blank line after copyright block in overall_status.rst
…evcontainer (eclipse-score#269) * chore: Bump devcontainer to v.1.7.0 * doc: remove scrample references in the EB clfsa documentation The scrample code had been removed already but this document was forgotten.
Co-authored-by: Frank Scholter Peres(MBTI) <145544737+FScholPer@users.noreply.github.com>
* Integrate Time module * Deploy time examples * Make sure qemu has enought permisisons * Make exmplaes stop after time
…e#274) The latest version of toolchain provides support for coverage for QNX builds. Signed-off-by: Nikola Radakovic <nikola.ra.radakovic@bmw.de>
* Add QNX8 aarch64 build support * review findings * free more space
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.