From 1d56d623b81430dc41d88533c76cdbf1404fd77e Mon Sep 17 00:00:00 2001 From: Adam Howard Date: Sat, 31 Aug 2019 10:01:21 +0100 Subject: [PATCH 1/3] doc(README): add install howto --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/README.md b/README.md index 9326ec6..575d77f 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,48 @@ which is capable of transcribing most orthographical information present in a la Some languages are partially or completely incompatible with this approach; [details are below](#depth). +## How To Install + +First, add the jitpack repository if youhaven't already: + +`gradle` +``` gradle + allprojects { + repositories { + ... + maven { url 'https://jitpack.io' } + } + } +``` + +`maven` +``` maven + + + jitpack.io + https://jitpack.io + + +``` + +Then add this library to your project: + +`gradle` +``` gradle + dependencies { + implementation 'com.github.medavox:IPA-Transcribers:v0.1' + } +``` + +`maven` +``` + + com.github.medavox + IPA-Transcribers + v0.1 + +``` + ## Language Support The languages I aim to support, and their eligibility for rule-based transcribers: From 334232e3839993e2d23dfc95f1029cdf999cb53d Mon Sep 17 00:00:00 2001 From: Adam Howard Date: Sat, 31 Aug 2019 10:04:03 +0100 Subject: [PATCH 2/3] doc(README): tweak install how-to --- README.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 575d77f..d72dac8 100644 --- a/README.md +++ b/README.md @@ -15,40 +15,40 @@ First, add the jitpack repository if youhaven't already: `gradle` ``` gradle - allprojects { - repositories { - ... - maven { url 'https://jitpack.io' } - } - } +allprojects { + repositories { + ... + maven { url 'https://jitpack.io' } + } +} ``` `maven` -``` maven - - - jitpack.io - https://jitpack.io - - +``` xml + + + jitpack.io + https://jitpack.io + + ``` Then add this library to your project: `gradle` ``` gradle - dependencies { - implementation 'com.github.medavox:IPA-Transcribers:v0.1' - } +dependencies { + implementation 'com.github.medavox:IPA-Transcribers:v0.1' +} ``` `maven` -``` - - com.github.medavox - IPA-Transcribers - v0.1 - +``` xml + + com.github.medavox + IPA-Transcribers + v0.1 + ``` ## Language Support From 7245472fa0b01e33b878cb0846c4ca0b8cbd3b5d Mon Sep 17 00:00:00 2001 From: Adam Howard Date: Sat, 31 Aug 2019 10:04:26 +0100 Subject: [PATCH 3/3] doc(README): a space --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d72dac8..6e0d026 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ below](#depth). ## How To Install -First, add the jitpack repository if youhaven't already: +First, add the jitpack repository if you haven't already: `gradle` ``` gradle