readscore 1.0.0__tar.gz

readscore-1.0.0/.gitignore

@@ -0,0 +1,233 @@
+# SPDX-FileCopyrightText: 2025 Knitli Inc.
+# SPDX-FileContributor: Adam Poulemanos <adam@knit.li>
+#
+# SPDX-License-Identifier: MIT OR Apache-2.0
+
+# local configs
+.claude/*.local.*
+**/*.local.*
+**/*.local.*.license
+mise.local.toml
+mise.*.local.toml
+mise.local.toml.license
+mise.*.local.toml.license
+hk.local.pkl.license
+.ruff_cache
+.roo/mcp.json
+# local terminal zsh config -- can contain sensitive info
+.vscode/terminal.local.zsh
+*mcp*.backup*
+
+# CLAUDE.md -- we symlink this file from AGENTS.md in the setup script
+CLAUDE.md
+GEMINI.md
+
+# non-public working files
+.workbench/
+.devenv/
+.testbuild/
+.history
+.temp/
+
+# Workspace files
+*.code-workspace
+*.code-workspace.license
+
+# mkdocs
+.cache
+
+# Playwright
+logs
+_.log
+report.[0-9]_[0-9]_[0-9]_[0-9]_.json
+out
+dist/
+*.tgz
+coverage
+*.lcov
+.env
+*.local.*
+*.local
+.eslintcache
+.cache
+!.cache/uv/
+*.tsbuildinfo
+**/dist/
+
+# venv
+**/.venv
+.venv/
+
+# node and docs-site
+node_modules/
+**/node_modules/
+docs-site/dist/
+docs-site/.cache/
+docs-site/.astro/
+docs-site/.wrangler/
+
+# Cache files
+**/__pycache__/
+**/.pytest_cache/
+__pycache__/
+.pytest_cache/
+.eslintcache
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+.pytest_cache
+
+dist/
+site/
+*.tar
+*.tar.*
+*.jar
+*.exe
+*.msi
+*.zip
+*.tgz
+*.log
+*.log.*
+*.sig
+
+.DS_Store
+*.swp
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Local config
+ipython_config.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+[Ww][Ii][Nn]32/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
+bld/
+[Oo]bj/
+[Ll]og/
+[Ll]ogs/
+
+# Files built by Visual Studio
+*_i.c
+*_p.c
+*_h.h
+*.ilk
+*.meta
+*.obj
+*.iobj
+*.pch
+*.pdb
+*.ipdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*_wpftmp.csproj
+*.log
+*.tlog
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Including strong name files can present a security risk
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+*.snk
+
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+bower_components/
+
+# Local History for Visual Studio Code
+.history/
+lib64/
+remote-debug-profile/
+
+# zcomp and zhistory files
+.vscode/zsh/.zcompdump
+.vscode/zsh/.zcompdump-*
+.vscode/zsh/.zsh_history
+
+__pycache__/
+# //!SECTION  EXCEPTIONS -- Put all inverted ("!") rules at the end of the file!
+
+# but keep track of directories ending in .cache
+!?*.[Cc]ache/
+
+# Leave launch.json public
+!.vscode/launch.json
+!.vscode/launch.json.license
+
+# Leave settings.json and workspace zshrc/init public
+!.vscode/tasks.json
+!.vscode/tasks.json.license
+!.vscode/extensions.json
+!.vscode/extensions.json.license
+!.vscode/mcp.json
+!.vscode/mcp.json.license
+!.vscode/settings.json
+!.vscode/settings.json.license
+!.vscode/terminal.extra.zsh
+!.vscode/terminal.extra.zsh.example
+!.vscode/zsh/.zshrc
+
+# project-level git files that should be public and easily get caught in ignores
+!.gitattributes
+!.gitconfig.license
+!.gitignore
+!.gitconfig
+!.mailmap
+
+!.cache/uv/
+
+# Generated Files
+**/htmlcov/
+htmlcov/
+.coverage
+.coveragexml
+.vscode/.history/
+coverage.xml
+docs-site/dist/
+htmlcov/
+lcov-report/
+server.json
+server.json.license
+server.yaml
+server.yaml.license
+src/readscore/__about__.py
+test-results.xml
+
+.jj/
+
+# Finally, stuff we *really* don't want to let leak
+.local.env
+.codeweaver.local.env
+.codeweaver/local.env
+mise.local.toml
+mise.local.env
+
+.gemini/
+gha-creds-*.json

readscore-1.0.0/LICENSES/Apache-2.0.txt

@@ -0,0 +1,73 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readscore copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

readscore-1.0.0/LICENSES/LicenseRef-PlainMIT.md

@@ -0,0 +1,32 @@
+# Plain MIT License
+
+Copyright Notice: (c) 2026 PlainLicense
+
+## You Can Do Anything with The Work
+
+We give you permission to:
+- **Use** it
+- **Copy** it
+- **Change** it
+- **Share** it
+- **Sell** it
+- **Mix** or put it together with other works
+
+You can do all of these things **for free**. You can do them for any reason.
+Everyone else can do these things too, as long as they follow these rules.
+
+## **If** You Give Us Credit and Keep This Notice
+
+You can do any of these things with the work, **if you follow these two rules**:
+
+1. **You must keep our copyright notice**. This tells people who created the work.
+2. **You must *also* keep this notice with all versions of the work**. 
+
+## No Promises
+
+We give the work to you as it is, without any promises or guarantees. This means:
+
+- **"As is"**: You get the work exactly how it is, including anything broken.
+- **No Guarantees**: We are not promising it will work well for any specific tasks, or that it will not break any rules. It may not work at all.
+
+We are not responsible for any problems or damages that happen because of the work. You use it at your own risk.

readscore-1.0.0/LICENSES/MIT.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 PlainLicense
+Copyright (c) 2018 Carmine M DiMascio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

readscore-1.0.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: readscore
+Version: 1.0.0
+Summary: Modernized readability scoring for Python
+Project-URL: Changelog, https://github.com/plainlicense/readscore/releases
+Project-URL: Documentation, https://docs.plainlicense.org/readscore/
+Project-URL: Issues, https://github.com/plainlicense/readscore/issues
+Project-URL: Repository, https://github.com/plainlicense/readscore
+Author: Carmine M DiMascio
+Author-email: PlainLicense <hello@plainlicense.org>, Adam Poulemanos <adam@plainlicense.org>
+License-File: LICENSES/Apache-2.0.txt
+License-File: LICENSES/LicenseRef-PlainMIT.md
+License-File: LICENSES/MIT.md
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Requires-Dist: lateimport>=0.1.0
+Requires-Dist: nltk>=3.9.3
+Description-Content-Type: text/markdown
+
+<!--
+SPDX-FileCopyrightText: 2026 PlainLicense
+
+SPDX-License-Identifier: LicenseRef-PlainMIT OR MIT
+-->
+
+<p align="center">
+  <img src="docs-site/src/assets/images/readscore_logo.svg" alt="readscore" width="120" />
+</p>
+
+# readscore
+[![MIT license](https://img.shields.io/badge/License-MIT-green.svg)](https://lbesson.mit-license.org/)
+
+Score the _readability_ of text using popular readability formulas and metrics including: [Flesch Kincaid Grade Level](#flesch-kincaid-grade-level), [Flesch Reading Ease](#flesch-reading-ease), [Gunning Fog Index](#gunning-fog), [Dale Chall Readability](#dale-chall-readability), [Automated Readability Index (ARI)](#automated-readability-index-ari), [Coleman Liau Index](#coleman-liau-index), [Linsear Write](#linsear-write), [SMOG](#smog), and [SPACHE](#spache).
+
+[![GitHub stars](https://img.shields.io/github/stars/plainlicense/readscore.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/plainlicense/readscore/stargazers/)
+
+## Prerequisites
+
+- Python 3.12 or higher
+
+## Installation
+
+```bash
+pip install readscore
+```
+
+## Quick Start
+
+```python
+from readscore import Readability
+
+text = """
+In linguistics, the Gunning fog index is a readability test for English writing. 
+The index estimates the years of formal education a person needs to understand 
+the text on the first reading. For instance, a fog index of 12 requires the 
+reading level of a United States high school senior (around 18 years old). 
+The test was developed in 1952 by Robert Gunning, an American businessman 
+who had been involved in newspaper and textbook publishing.
+"""
+
+r = Readability(text)
+
+# Automated Readability Index (ARI)
+ari = r.ari()
+print(f"ARI Score: {ari.score}")
+print(f"Grade Levels: {ari.grade_levels}")
+print(f"Ages: {ari.ages}")
+
+# Flesch Reading Ease
+flesch = r.flesch()
+print(f"Flesch Score: {flesch.score}")
+print(f"Ease: {flesch.ease}")
+
+# Flesch-Kincaid Grade Level
+fk = r.flesch_kincaid()
+print(f"FK Score: {fk.score}")
+print(f"Grade Level: {fk.grade_level}")
+
+# Get all statistics used for calculation
+stats = r.statistics()
+print(stats)
+
+# For custom metrics, use r.stats (returns a StatSummary object)
+print(r.stats)
+```
+
+For score interpretation, metric selection, and full API docs, see **[docs.plainlicense.org/readscore](https://docs.plainlicense.org/readscore/)**.
+
+## About
+
+readscore is a fork of the excellent [py-readability-metrics](https://github.com/cdimascio/py-readability-metrics) library by [Carmine DiMascio (@cdimascio)](https://github.com/cdimascio). We wanted to build on the great work that Carmine did, and add some additional features and metrics as an engine for future [Plain License](https://plainlicense.org/) projects, like our in-development CLI tool, [**plainr**](https://github.com/plainlicense/plainr) and similar plain language focused CI/CD tools. We also wanted to make some major breaking changes to the API and add robust typing support, so we decided to fork the project and start fresh.
+
+## Supported Metrics
+
+- **ARI** (Automated Readability Index)
+- **Coleman-Liau** Index
+- **Dale-Chall** Readability Score
+- **Flesch** Reading Ease
+- **Flesch-Kincaid** Grade Level
+- **Gunning Fog** Index
+- **Linsear Write** Formula
+- **SMOG** Index
+- **Spache** Readability Formula
+
+## Acknowledgements
+
+readscore is a fork of [py-readability-metrics](https://github.com/cdimascio/py-readability-metrics)
+by [Carmine DiMascio](https://github.com/cdimascio). We are grateful for that foundation.

readscore-1.0.0/README.md

@@ -0,0 +1,89 @@
+<!--
+SPDX-FileCopyrightText: 2026 PlainLicense
+
+SPDX-License-Identifier: LicenseRef-PlainMIT OR MIT
+-->
+
+<p align="center">
+  <img src="docs-site/src/assets/images/readscore_logo.svg" alt="readscore" width="120" />
+</p>
+
+# readscore
+[![MIT license](https://img.shields.io/badge/License-MIT-green.svg)](https://lbesson.mit-license.org/)
+
+Score the _readability_ of text using popular readability formulas and metrics including: [Flesch Kincaid Grade Level](#flesch-kincaid-grade-level), [Flesch Reading Ease](#flesch-reading-ease), [Gunning Fog Index](#gunning-fog), [Dale Chall Readability](#dale-chall-readability), [Automated Readability Index (ARI)](#automated-readability-index-ari), [Coleman Liau Index](#coleman-liau-index), [Linsear Write](#linsear-write), [SMOG](#smog), and [SPACHE](#spache).
+
+[![GitHub stars](https://img.shields.io/github/stars/plainlicense/readscore.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/plainlicense/readscore/stargazers/)
+
+## Prerequisites
+
+- Python 3.12 or higher
+
+## Installation
+
+```bash
+pip install readscore
+```
+
+## Quick Start
+
+```python
+from readscore import Readability
+
+text = """
+In linguistics, the Gunning fog index is a readability test for English writing. 
+The index estimates the years of formal education a person needs to understand 
+the text on the first reading. For instance, a fog index of 12 requires the 
+reading level of a United States high school senior (around 18 years old). 
+The test was developed in 1952 by Robert Gunning, an American businessman 
+who had been involved in newspaper and textbook publishing.
+"""
+
+r = Readability(text)
+
+# Automated Readability Index (ARI)
+ari = r.ari()
+print(f"ARI Score: {ari.score}")
+print(f"Grade Levels: {ari.grade_levels}")
+print(f"Ages: {ari.ages}")
+
+# Flesch Reading Ease
+flesch = r.flesch()
+print(f"Flesch Score: {flesch.score}")
+print(f"Ease: {flesch.ease}")
+
+# Flesch-Kincaid Grade Level
+fk = r.flesch_kincaid()
+print(f"FK Score: {fk.score}")
+print(f"Grade Level: {fk.grade_level}")
+
+# Get all statistics used for calculation
+stats = r.statistics()
+print(stats)
+
+# For custom metrics, use r.stats (returns a StatSummary object)
+print(r.stats)
+```
+
+For score interpretation, metric selection, and full API docs, see **[docs.plainlicense.org/readscore](https://docs.plainlicense.org/readscore/)**.
+
+## About
+
+readscore is a fork of the excellent [py-readability-metrics](https://github.com/cdimascio/py-readability-metrics) library by [Carmine DiMascio (@cdimascio)](https://github.com/cdimascio). We wanted to build on the great work that Carmine did, and add some additional features and metrics as an engine for future [Plain License](https://plainlicense.org/) projects, like our in-development CLI tool, [**plainr**](https://github.com/plainlicense/plainr) and similar plain language focused CI/CD tools. We also wanted to make some major breaking changes to the API and add robust typing support, so we decided to fork the project and start fresh.
+
+## Supported Metrics
+
+- **ARI** (Automated Readability Index)
+- **Coleman-Liau** Index
+- **Dale-Chall** Readability Score
+- **Flesch** Reading Ease
+- **Flesch-Kincaid** Grade Level
+- **Gunning Fog** Index
+- **Linsear Write** Formula
+- **SMOG** Index
+- **Spache** Readability Formula
+
+## Acknowledgements
+
+readscore is a fork of [py-readability-metrics](https://github.com/cdimascio/py-readability-metrics)
+by [Carmine DiMascio](https://github.com/cdimascio). We are grateful for that foundation.

readscore-1.0.0/docs-site/README.md

@@ -0,0 +1,55 @@
+<!--
+SPDX-FileCopyrightText: 2026 PlainLicense
+
+SPDX-License-Identifier: LicenseRef-PlainMIT OR MIT
+-->
+
+# Starlight Starter Kit: Basics
+
+[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
+
+```
+npm create astro@latest -- --template starlight
+```
+
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
+## 🚀 Project Structure
+
+Inside of your Astro + Starlight project, you'll see the following folders and files:
+
+```
+.
+├── public/
+├── src/
+│   ├── assets/
+│   ├── content/
+│   │   └── docs/
+│   └── content.config.ts
+├── astro.config.mjs
+├── package.json
+└── tsconfig.json
+```
+
+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
+
+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+
+Static assets, like favicons, can be placed in the `public/` directory.
+
+## 🧞 Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command                   | Action                                           |
+| :------------------------ | :----------------------------------------------- |
+| `npm install`             | Installs dependencies                            |
+| `npm run dev`             | Starts local dev server at `localhost:4321`      |
+| `npm run build`           | Build your production site to `./dist/`          |
+| `npm run preview`         | Preview your build locally, before deploying     |
+| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI                     |
+
+## 👀 Want to learn more?
+
+Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).