|
1 | | -=========== |
2 | | -Doma の開発 |
3 | | -=========== |
| 1 | +=================== |
| 2 | +Development of Doma |
| 3 | +=================== |
4 | 4 |
|
5 | | -.. contents:: 目次 |
| 5 | +.. contents:: |
6 | 6 | :depth: 3 |
7 | 7 |
|
8 | 8 | .. note:: |
9 | 9 |
|
10 | | - このページは Doma の開発者に向けて書かれています。 |
| 10 | + This document is written for the developers of Doma. |
11 | 11 |
|
12 | | -ソースコード |
13 | | -============ |
| 12 | +Before You Start |
| 13 | +================ |
| 14 | + |
| 15 | +To build you will need Git and JDK 8. |
| 16 | +Be sure that your ``JAVA_HOME`` environment variable points to the ``jdk1.8.0`` folder extracted from the JDK download. |
| 17 | + |
| 18 | +Get the Source Code |
| 19 | +=================== |
14 | 20 |
|
15 | 21 | .. code-block:: bash |
16 | 22 |
|
17 | 23 | $ git clone https://github.com/domaframework/doma.git |
| 24 | + $ cd doma |
18 | 25 |
|
19 | | -ビルド |
20 | | -====== |
| 26 | +Build from the Command Line |
| 27 | +=========================== |
21 | 28 |
|
22 | 29 | .. code-block:: bash |
23 | 30 |
|
24 | 31 | $ ./gradlew build |
25 | 32 |
|
26 | | -Maven ローカルリポジトリへのインストール |
27 | | ----------------------------------------- |
| 33 | +Format the Source Code |
| 34 | +====================== |
28 | 35 |
|
29 | | -.. code-block:: bash |
| 36 | +We use `google-java-format`_ 1.6 for code formatting. |
30 | 37 |
|
31 | | - $ ./gradlew build install |
| 38 | +Command Line |
| 39 | +------------ |
32 | 40 |
|
33 | | -.. note:: |
| 41 | +Use the `Spotless`_ gradle plugin: |
34 | 42 |
|
35 | | - ローカルで修正を加えたコードに対して :doc:`integration-test` を実行するには、 |
36 | | - ローカルの Maven リポジトリに |
37 | | - Doma 本体の成果物を事前にインストールしておく必要があります。 |
| 43 | +.. code-block:: bash |
38 | 44 |
|
39 | | -Eclipse |
40 | | -======= |
| 45 | + $ ./gradlew spotlessApply |
41 | 46 |
|
42 | | -Eclipse の設定ファイルを生成できます。 |
| 47 | +IntelliJ |
| 48 | +-------- |
43 | 49 |
|
44 | | -.. code-block:: bash |
| 50 | +Use the `google-java-format IntelliJ plugin`_. |
45 | 51 |
|
46 | | - $ ./gradlew eclipse |
| 52 | +Eclipse |
| 53 | +------- |
47 | 54 |
|
| 55 | +Use the `google-java-format Eclipse plugin`_. |
48 | 56 |
|
49 | 57 | Continuous Integration |
50 | 58 | ====================== |
51 | 59 |
|
52 | | -Continuous Integration の実行には `Travis CI`_ を利用しています。 |
| 60 | +We use `Travis CI`_ for CI. |
| 61 | +All pull requests to master brunch are tested on Travis CI. |
53 | 62 |
|
54 | 63 | https://travis-ci.org/domaframework/doma |
55 | 64 |
|
56 | | -ドキュメント |
| 65 | +Documents |
57 | 66 | ============ |
58 | 67 |
|
59 | | -ドキュメントの作成には `Sphinx`_ を利用しています。 |
| 68 | +We use `Sphinx`_ to generate documents. |
| 69 | +To use Sphinx you will need Python. |
60 | 70 |
|
61 | | -環境構築 |
62 | | --------- |
| 71 | +Set up an environment |
| 72 | +--------------------- |
63 | 73 |
|
64 | 74 | .. code-block:: bash |
65 | 75 |
|
66 | 76 | $ cd docs |
67 | 77 | $ pip install -r requirements.txt |
68 | 78 |
|
69 | | -ドキュメントの生成と確認 |
70 | | -------------------------------- |
| 79 | +Generate HTML files |
| 80 | +------------------- |
71 | 81 |
|
72 | | -docsディレクトリで次のコマンドを実行します。 |
| 82 | +Execute the `sphinx-autobuild`_ command in the ``docs`` directory: |
73 | 83 |
|
74 | 84 | .. code-block:: bash |
75 | 85 |
|
76 | 86 | $ sphinx-autobuild . _build/html |
77 | 87 |
|
78 | | -ブラウザで `http://127.0.0.1:8000` にアクセスするとビルドされたドキュメントを確認できます。 |
79 | | -ドキュメントへの修正は即座にブラウザ上に反映されます。 |
| 88 | +Visit the webpage served at http://127.0.0.1:8000. |
80 | 89 |
|
81 | 90 |
|
| 91 | +.. _google-java-format: https://github.com/google/google-java-format |
| 92 | +.. _google-java-format IntelliJ plugin: https://github.com/google/google-java-format#intellij |
| 93 | +.. _google-java-format Eclipse plugin: https://github.com/google/google-java-format#eclipse |
| 94 | +.. _Spotless: https://github.com/diffplug/spotless |
82 | 95 | .. _Travis CI: http://docs.travis-ci.com/ |
83 | 96 | .. _Sphinx: http://sphinx-doc.org/ |
84 | | - |
| 97 | +.. _sphinx-autobuild: https://pypi.org/project/sphinx-autobuild/ |
0 commit comments