Browse Source

Updated readme and added build scripts

example-sentences
Macoy Madson 7 months ago
parent
commit
b73fc8f739
3 changed files with 35 additions and 0 deletions
  1. +3
    -0
      Build_Debug.sh
  2. +3
    -0
      Build_Release.sh
  3. +29
    -0
      ReadMe.org

+ 3
- 0
Build_Debug.sh View File

@@ -0,0 +1,3 @@
#!/bin/sh

jam -j4 -sDEBUG_BUILD=true

+ 3
- 0
Build_Release.sh View File

@@ -0,0 +1,3 @@
#!/bin/sh

jam -j4

+ 29
- 0
ReadMe.org View File

@@ -3,5 +3,34 @@
My tailor-made suite for studying Japanese.

* Setup
** Clone Repository
Download submodules as well:

#+BEGIN_SRC sh
git clone --recurse-submodules https://github.com/makuto/japanese-for-me
#+END_SRC
** Install Dependencies
Jam is used to build Japanese for Me. You will need a C++ toolchain (clang or gcc) installed as well.

#+BEGIN_SRC sh
sudo apt install jam
#+END_SRC
** Prepare Anki
Anki is used to manage spaced repitition.

- [[https://foosoft.net/projects/anki-connect/index.html#installation][Install AnkiConnect]]
- Run Anki
** Building
Build CURL:
#+BEGIN_SRC sh
./BuildDependencies_Debug.sh
#+END_SRC

Build Japanese for Me:
#+BEGIN_SRC sh
./Build_Debug.sh
#+END_SRC
* License
The repository itself is under the MIT license.

Tatoeba corpus licensing details are available [[https://tatoeba.org/eng/terms_of_use#section-6][here]]. They vary per-sentence in license, so I will assume attribution is required per-sentence (which is the most restrictive license they have).

Loading…
Cancel
Save