Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #46

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README #46

wants to merge 1 commit into from

Conversation

cansavvy
Copy link
Contributor

@cansavvy cansavvy commented Mar 3, 2025

Purpose/implementation Section

What changes are being implemented in this Pull Request?

The README has still been the default OTTR one. So I'm making it specific to this work.

Copy link
Contributor

github-actions bot commented Mar 3, 2025

No quiz formatting errors! 🎉
Comment updated at 2025-03-03-19:34:53 with changes from 070ab17

Copy link
Contributor

github-actions bot commented Mar 3, 2025

No broken url errors! 🎉
Comment updated at 2025-03-03-19:34:49 with changes from 070ab17

Copy link
Contributor

github-actions bot commented Mar 3, 2025

No spelling errors! 🎉
Comment updated at 2025-03-03-19:34:53 with changes from 070ab17

@cansavvy
Copy link
Contributor Author

cansavvy commented Mar 3, 2025

Overall readability score: 63.69 (🟢 +11.53)

File Readability
README.md 52.71 (🔴 -2.07)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
README.md 52.71 42.58 9.91 10.8 13.67 9.04
  🔴 -2.07 🔴 -7.04 🔴 -0.46 🟢 +1.6 🟢 +0.41 🔴 -0.94

Averages:

  Readability FRE GF ARI CLI DCRS
Average 63.69 62.62 10.37 14.35 9.72 6.54
  🟢 +11.53 🟢 +12.03 🟢 +1.54 🟢 +1.59 🟢 +1.47 🟢 +0.78
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

Copy link
Contributor

github-actions bot commented Mar 3, 2025

Re-rendered previews from the latest commit:

* note not all html features will be properly displayed in the "quick preview" but it will give you a rough idea.

Updated at 2025-03-03 with changes from the latest commit 070ab17

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