Skip to content
This repository has been archived by the owner on Jun 21, 2022. It is now read-only.

Commit

Permalink
Refreshed commit
Browse files Browse the repository at this point in the history
  • Loading branch information
brackendev committed Jun 29, 2019
0 parents commit ebc9949
Show file tree
Hide file tree
Showing 25 changed files with 1,703 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
*.pbxproj -crlf -diff -merge
*.xib -crlf -diff -merge
*.nib -crlf -diff -merge

# Disable line ending conversions for all files
* -text

24 changes: 24 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.DS_Store
.Trashes
*.swp
*.lock
profile
*~.nib
DerivedData/
build/
*.pbxuser
*.mode1v3
*.mode2v3
*.perspectivev3
!default.pbxuser
!default.mode1v3
!default.mode2v3
!default.perspectivev3
*.moved-aside
Pods/
Podfile.lock
*.xcuserstate
.idea/
xcuserdata/
project.xcworkspace/
xcuserdata/
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "Readability/objC-syllable-counter"]
path = Readability/objC-syllable-counter
url = https://github.com/brackendev/objC-syllable-counter.git
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2014-2019 brackendev

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.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
Readability-Objective-C
=======================
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d9b21f69a0c54ee08897e745e6285443)](https://www.codacy.com/app/brackendev/Readability-Objective-C?utm_source=github.com&utm_medium=referral&utm_content=brackendev/Readability-Objective-C&utm_campaign=Badge_Grade)

**Metrics to determine readability and comprehension difficulty for contemporary English text.**

* [iOS](https://en.wikipedia.org/wiki/IOS) reference platform.
* Example app and tests included.

## Installation

Git clone this repository. [objC-syllable-counter](https://github.com/brackendev/objC-syllable-counter.git) submodule is required, so be sure to clone like this:

````bash
git clone --recursive https://github.com/brackendev/Readability-Objective-C.git
````

## Metrics Included

* [Automated Readability Index](http://en.wikipedia.org/wiki/Automated_Readability_Index)
* [Coleman–Liau Index](http://en.wikipedia.org/wiki/Coleman–Liau_index)
* [Flesch-Kincaid Grade Level](http://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests)
* [Flesch Reading Ease](http://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests)
* [Gunning Fog Index](http://en.wikipedia.org/wiki/Gunning_fog_index)
* [SMOG Grade](http://en.wikipedia.org/wiki/SMOG)

## Usage

See the [view controller](https://github.com/brackendev/Readability-Objective-C/blob/master/Readability-Objective-C%20Example/Readability-Objective-C%20Example/Classes/ViewController.m) in the example app.

## Ports

* [Pharo](http://brackendev.github.io/Readability-Pharo/)
* [Swift](http://brackendev.github.io/Readability-Swift/)
* [VisualWorks](https://brackendev.github.io/Readability-VisualWorks/)

## Acknowledgements

* [E.A. Smith, EdD and R.J. Senter, PhD](https://apps.dtic.mil/dtic/tr/fulltext/u2/667273.pdf), for the [Automated Readability Index](http://en.wikipedia.org/wiki/Automated_Readability_Index).
* [Meri Coleman and T.L. Liau](https://psycnet.apa.org/record/1975-22007-001) for the [Coleman–Liau Index](http://en.wikipedia.org/wiki/Coleman–Liau_index).
* [Rudolf Flesch](https://en.wikipedia.org/wiki/Rudolf_Flesch) and [J. Peter Kincaid](https://en.wikipedia.org/wiki/J._Peter_Kincaid) for the [Flesch-Kincaid Grade Level](http://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests).
* [Rudolf Flesch](https://en.wikipedia.org/wiki/Rudolf_Flesch) for the [Flesch Reading Ease](https://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests#Flesch_reading_ease).
* Robert Gunning for the [Gunning Fog Index](http://en.wikipedia.org/wiki/Gunning_fog_index).
* [G. Harry McLaughlin](https://ogg.osu.edu/media/documents/health_lit/WRRSMOG_Readability_Formula_G._Harry_McLaughlin__1969_.pdf) for the [SMOG Grade](http://en.wikipedia.org/wiki/SMOG).

## Author

[brackendev](https://www.github.com/brackendev)

## License

Readability-Objective-C is released under the MIT license. See the LICENSE file for more info.
Loading

0 comments on commit ebc9949

Please sign in to comment.