Skip to content

Commit 02aee27

Browse files
authored
Merge pull request #260 from domaframework/translate-development.rst
Translate development.rst
2 parents 4b36def + 1f8bb04 commit 02aee27

File tree

1 file changed

+46
-33
lines changed

1 file changed

+46
-33
lines changed

docs/development.rst

Lines changed: 46 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,97 @@
1-
===========
2-
Doma の開発
3-
===========
1+
===================
2+
Development of Doma
3+
===================
44

5-
.. contents:: 目次
5+
.. contents::
66
:depth: 3
77

88
.. note::
99

10-
このページは Doma の開発者に向けて書かれています。
10+
This document is written for the developers of Doma.
1111

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+
===================
1420

1521
.. code-block:: bash
1622
1723
$ git clone https://github.com/domaframework/doma.git
24+
$ cd doma
1825
19-
ビルド
20-
======
26+
Build from the Command Line
27+
===========================
2128

2229
.. code-block:: bash
2330
2431
$ ./gradlew build
2532
26-
Maven ローカルリポジトリへのインストール
27-
----------------------------------------
33+
Format the Source Code
34+
======================
2835

29-
.. code-block:: bash
36+
We use `google-java-format`_ 1.6 for code formatting.
3037

31-
$ ./gradlew build install
38+
Command Line
39+
------------
3240

33-
.. note::
41+
Use the `Spotless`_ gradle plugin:
3442

35-
ローカルで修正を加えたコードに対して :doc:`integration-test` を実行するには、
36-
ローカルの Maven リポジトリに
37-
Doma 本体の成果物を事前にインストールしておく必要があります。
43+
.. code-block:: bash
3844
39-
Eclipse
40-
=======
45+
$ ./gradlew spotlessApply
4146
42-
Eclipse の設定ファイルを生成できます。
47+
IntelliJ
48+
--------
4349

44-
.. code-block:: bash
50+
Use the `google-java-format IntelliJ plugin`_.
4551

46-
$ ./gradlew eclipse
52+
Eclipse
53+
-------
4754

55+
Use the `google-java-format Eclipse plugin`_.
4856

4957
Continuous Integration
5058
======================
5159

52-
Continuous Integration の実行には `Travis CI`_ を利用しています。
60+
We use `Travis CI`_ for CI.
61+
All pull requests to master brunch are tested on Travis CI.
5362

5463
https://travis-ci.org/domaframework/doma
5564

56-
ドキュメント
65+
Documents
5766
============
5867

59-
ドキュメントの作成には `Sphinx`_ を利用しています。
68+
We use `Sphinx`_ to generate documents.
69+
To use Sphinx you will need Python.
6070

61-
環境構築
62-
--------
71+
Set up an environment
72+
---------------------
6373

6474
.. code-block:: bash
6575
6676
$ cd docs
6777
$ pip install -r requirements.txt
6878
69-
ドキュメントの生成と確認
70-
-------------------------------
79+
Generate HTML files
80+
-------------------
7181

72-
docsディレクトリで次のコマンドを実行します。
82+
Execute the `sphinx-autobuild`_ command in the ``docs`` directory:
7383

7484
.. code-block:: bash
7585
7686
$ sphinx-autobuild . _build/html
7787
78-
ブラウザで `http://127.0.0.1:8000` にアクセスするとビルドされたドキュメントを確認できます。
79-
ドキュメントへの修正は即座にブラウザ上に反映されます。
88+
Visit the webpage served at http://127.0.0.1:8000.
8089

8190

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
8295
.. _Travis CI: http://docs.travis-ci.com/
8396
.. _Sphinx: http://sphinx-doc.org/
84-
97+
.. _sphinx-autobuild: https://pypi.org/project/sphinx-autobuild/

0 commit comments

Comments
 (0)