README.md
1[Mozc - a Japanese Input Method Editor designed for multi-platform](https://github.com/google/mozc)
2===================================
3
4Copyright 2010-2018, Google Inc.
5
6Mozc is a Japanese Input Method Editor (IME) designed for multi-platform such as
7Android OS, Apple OS X, Chromium OS, GNU/Linux and Microsoft Windows. This
8OpenSource project originates from
9[Google Japanese Input](http://www.google.com/intl/ja/ime/).
10
11This branch is modified version of Mozc primarily for FreeBSD.
12Changes include:
13
14* Define OS_FREEBSD. It is mixture of OS_LINUX and OS_MACOSX.
15* fcitx support. To enable this, --use-fcitx option is required.
16* C++11 fixes for GCC and Clang.
17* Support non-standard directories for tools and renderer via --tool_dir and --renderer_dir options.
18* --localbase option has been added to specify location of commands instead of hard-coded "/usr/bin".
19* Add options for compiler flags: --ldflas, --cflags, --cflags_cc, and --include-dirs.
20* Add options for build concurreny: --jobs.
21
22These patches are maintained by Hiroki Sato <hrs@FreeBSD.org>.
23
24The original README can be found at [README_orig.md](README_orig.md)
25
README_orig.md
1[Mozc - a Japanese Input Method Editor designed for multi-platform](https://github.com/google/mozc)
2===================================
3
4Copyright 2010-2018, Google Inc.
5
6Mozc is a Japanese Input Method Editor (IME) designed for multi-platform such as
7Android OS, Apple OS X, Chromium OS, GNU/Linux and Microsoft Windows. This
8OpenSource project originates from
9[Google Japanese Input](http://www.google.com/intl/ja/ime/).
10
11What's Mozc?
12------------
13For historical reasons, the project name *Mozc* has two different meanings:
14
151. Internal code name of Google Japanese Input that is still commonly used
16 inside Google.
172. Project name to release a subset of Google Japanese Input in the form of
18 source code under OSS license without any warranty nor user support.
19
20In this repository, *Mozc* means the second definition unless otherwise noted.
21
22Detailed differences between Google Japanese Input and Mozc are described in [About Branding](docs/about_branding.md).
23
24Build Instructions
25------------------
26
27* [How to build Mozc in Docker](docs/build_mozc_in_docker.md): Android, NaCl, and Linux desktop builds.
28* [How to build Mozc in OS X](docs/build_mozc_in_osx.md): OS X build.
29* [How to build Mozc in Windows](docs/build_mozc_in_windows.md): Windows build.
30
31Release Plan
32------------
33
34tl;dr. **There is no stable version.**
35
36As described in [About Branding](docs/about_branding.md) page, Google does
37not promise any official QA for OSS Mozc project. Because of this,
38Mozc does not have a concept of *Stable Release*. Instead we change version
39number every time when we introduce non-trivial change. If you are
40interested in packaging Mozc source code, or developing your own products
41based on Mozc, feel free to pick up any version. They should be equally
42stable (or equally unstable) in terms of no official QA process.
43
44[Release History](docs/release_history.md) page may have additional
45information and useful links about recent changes.
46
47License
48-------
49
50All Mozc code written by Google is released under
51[The BSD 3-Clause License](http://opensource.org/licenses/BSD-3-Clause).
52For thrid party code under [src/third_party](src/third_party) directory,
53see each sub directory to find the copyright notice. Note also that
54outside [src/third_party](src/third_party) following directories contain
55thrid party code.
56
57### [src/data/dictionary_oss/](src/data/dictionary_oss)
58
59Mixed.
60See [src/data/dictionary_oss/README.txt](src/data/dictionary_oss/README.txt)
61
62### [src/data/test/dictionary/](src/data/test/dictionary)
63
64The same to [src/data/dictionary_oss/](src/data/dictionary_oss).
65See [src/data/dictionary_oss/README.txt](src/data/dictionary_oss/README.txt)
66
67### [src/data/test/stress_test/](src/data/test/stress_test)
68
69Public Domain. See the comment in
70[src/data/test/stress_test/sentences.txt](src/data/test/stress_test/sentences.txt)
71
72### [src/data/unicode/](src/data/unicode)
73
74UNICODE, INC. LICENSE AGREEMENT.
75See each file header for details.
76