From 1fee327e089ea32640851fe83f7c53bc49b5ec1a Mon Sep 17 00:00:00 2001 From: Alexander Bezzubov Date: Wed, 21 Jun 2017 08:22:22 +0200 Subject: [PATCH 1/3] Add development instructions --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 598efe0..0cf902f 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,17 @@ fmt.Println(lang) // result: Objective-C ``` +Developmemt +----------- +*enry* re-uses parts of original [linguist](https://github.com/github/linguist) especially data in `languages.yml` to generate internal datastructures. In oreder to update to latest upstream run + + make clen code-generate + +To run the tests + + make test + + Why Enry? --------- In the movie [My Fair Lady](https://en.wikipedia.org/wiki/My_Fair_Lady), [Professor Henry Higgins](http://www.imdb.com/character/ch0011719/?ref_=tt_cl_t2) is one of the main characters. Henry is a linguist and at the very beginning of the movie enjoys guessing the nationality of people based on their accent. From 81c101ce4520f20148d7277be9234b5a9d452139 Mon Sep 17 00:00:00 2001 From: Alexander Bezzubov Date: Wed, 21 Jun 2017 09:07:55 +0200 Subject: [PATCH 2/3] Add API usage example --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0cf902f..29c0bd4 100644 --- a/README.md +++ b/README.md @@ -28,13 +28,16 @@ fmt.Println(lang) lang, _ = GetLanguageByContent("bar.m", "") fmt.Println(lang) // result: Objective-C + +// all strategies together +lang := enry.GetLanguage("foo.cpp", "") ``` Developmemt ----------- *enry* re-uses parts of original [linguist](https://github.com/github/linguist) especially data in `languages.yml` to generate internal datastructures. In oreder to update to latest upstream run - make clen code-generate + make clean code-generate To run the tests From f4528fcd8996d84667a7e286e011ccd318c41980 Mon Sep 17 00:00:00 2001 From: Alexander Bezzubov Date: Wed, 21 Jun 2017 12:06:16 +0200 Subject: [PATCH 3/3] docs: fixing typos --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 29c0bd4..5e022cf 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ lang, _ = GetLanguageByContent("foo.m", "") fmt.Println(lang) // result: Matlab -lang, _ = GetLanguageByContent("bar.m", "") +lang, _ = GetLanguageByContent("bar.m", "") fmt.Println(lang) // result: Objective-C @@ -35,7 +35,7 @@ lang := enry.GetLanguage("foo.cpp", "") Developmemt ----------- -*enry* re-uses parts of original [linguist](https://github.com/github/linguist) especially data in `languages.yml` to generate internal datastructures. In oreder to update to latest upstream run +*enry* re-uses parts of original [linguist](https://github.com/github/linguist) especially data in `languages.yml` to generate internal data structures. In oreder to update to latest upstream run make clean code-generate