Skip to content

score/time: Improve README.md with module-specific content #124

Description

@lavrovvalera

What

Replace the unmodified module template README.md with accurate, module-specific content following the conventions established by the lifecycle and baselibs peer modules.

Why

The current README contains template placeholders (wrong title, YOUR_PROJECT clone URL, src/ paths, Rust tooling references) and no information about what the Time module provides or how to use it. This makes the repository unhelpful for new contributors and consumers.

Proposed structure

The new README shall have the following sections, in order:

Section Content
# Time Module title + one-liner tagline + documentation badge
## Overview High-level capabilities: five clock domains, Clock<Tag> API, TimeDaemon (plugin-based time distribution daemon), TimeSlave, ts_client, test utilities
## Public API Bazel target labels (production + mock targets) grouped by clock domain
## Using as Dependency bazel_dep snippet + registry link + git_override for unreleased versions + required .bazelrc flags
## Documentation Feature docs link (score platform) + module docs link (inc_time site)
## Getting Started Devcontainer reference; build commands per platform/arch (Linux x86_64, Linux aarch64, QNX x86_64, QNX aarch64); test + sanitizer commands (--config=asan_ubsan_lsan); local docs generation (bazel run //:docs)
## Examples One sentence description + link to examples/
## Repository Structure Annotated directory tree reflecting actual layout (score/time/, score/time_daemon/, score/time_slave/, score/ts_client/, examples/, docs/)
## Contributing Link to CONTRIBUTION.md
## Support GitHub Issues link + Slack channel if exists

References

  • lifecycle README — sections structure, public API listing, platform build commands
  • baselibs READMEbazel_dep usage, git_override, sanitizers, devcontainer

Acceptance Criteria

  • All template placeholder content removed (wrong title, YOUR_PROJECT, src/ paths, Rust tooling, "docs planned" note, project_config.bzl section)
  • All sections from the structure above are present with correct, verified content
  • All bazel build / bazel test commands verified to work from a clean checkout
  • README renders correctly on GitHub (tables, code blocks, badge)
  • Reviewed by at least one other time module contributor

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Fields

No fields configured for Task.

Projects

Status
In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions