Skip to content

docs: rebuild the README on the shared q1k-oss skeleton - #3

Open
hshekhar-git wants to merge 4 commits into
mainfrom
docs/q1k-oss-readme
Open

hshekhar-git wants to merge 4 commits into
mainfrom
docs/q1k-oss-readme

Conversation

@hshekhar-git

Copy link
Copy Markdown
Member

Brings mint's README onto the same structure as the other three q1k-oss
packages: header block, then Overview, Highlights, Install, Quick start,
Usage, API reference, Development, Contributing, Related projects, License.

  • Adds the leaf mark from the open-source page as .github/logo.svg,
    traced from the raster original so it scales, with a dark-mode variant.
    The old .github/logo.png (leaf on a dark tile) is now unreferenced
    and is removed.
  • Links to the open-source page at q1k.ai/oss.
  • Keeps all the existing substance — benchmarks, format guide, CLI,
    API reference, spec grammar, roadmap — reorganised under the shared
    headings rather than rewritten.

Docs only; no source or package changes.

🤖 Generated with Claude Code

Same structure as the other three q1k-oss packages. Replaces the
dark-tile logo with the bare leaf from the open-source page, traced to
a vector so it scales; the old .github/logo.png is unreferenced now and
is removed.
The repo was renamed; npm still shows the old q1k-oss/mint URL, which
only resolves via GitHub's redirect.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant