StanfordSpezi/SpeziScheduler

Update the README based on the DocC documentation.

Open

#60 opened on Mar 2, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (2 assignees)Swift (5 forks)auto 404
documentationgood first issuehelp wanted

Repository metrics

Stars
 (6 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Problem

The current README doesn't reflect the README structure we have for other Spezi packages & the content in the DocC documentation. We should update this accordingly including all the elements that we have in the main pages of the targets in the package.

Solution

Update the README

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct and Contributing Guidelines

Contributor guide

Research direction
Compare the current README with the DocC documentation for this package and with READMEs of other Spezi packages. Identify missing sections (e.g., overview, installation, usage, contributing, license) and update accordingly.
Tech stack
swift
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90