Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Browse files

Adding instructions to README

  • Loading branch information...
1 parent 9382243 commit 75c1a2591fc87986af1c80819026944bb8cfca75 @eelco eelco committed
Showing with 58 additions and 0 deletions.
  1. +58 −0 README.txt
58 README.txt
@@ -0,0 +1,58 @@
+by Eelco Lempsink
+The Hyphenate category for NSString adds the method
+-stringByHyphenatingWithLocale: which will (try to) return
+the same string hyphenated with UTF-8 soft-hyphens.
+The hyphenation itself is done using the 'hyphen' library
+from the Hunspell project, which is also used by To support hyphenation for different
+languages, you can use the hyphenation dictionaries from the project.
+-- Setup
+ * Step 1 : Download prerequisites
+ Go to
+ and download the latest version of the Hyphen library
+ Download all the hyphenation libraries you want via
+ It might be easier to just pick the files from an FTP
+ mirror, they're located in the contrib/dictionaries
+ directory and all the file names start with 'hyph_'.
+ (
+ * Step 2 : Putting the code into place
+ Add the NSString+Hyphenate .h and .m file to your
+ project.
+ To statically add the hyphen library to your project add
+ the hyphen.h, hyphen.c and hnjalloc.h, hnjalloc.c files.
+ * Step 3 : Adding dictionaries
+ From the unzipped hyph_* files, copy the .dic file to
+ the bundle directory Hyphenate.bundle.
+ If you are going to use language detection, you also
+ need to provide the .dic files for just the language,
+ not the language plus location (e.g. copy or symlink
+ hyph_nl_NL.dic to hyph_nl.dic).
+ Add the Hyphenate.bundle to your project.
+-- Licensing
+The NSString+Hyphenate code is licensed under the BSD3
+license. Hunspell is licensed under a GPL 2.0/LGPL 2.1/MPL 1.1
+tri-license. The licensing of the hyphenation libraries
+differs and often there are multiple licenses available.

0 comments on commit 75c1a25

Please sign in to comment.
Something went wrong with that request. Please try again.