Skip to content

Commit

Permalink
Some tweaks to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yasusii committed Oct 24, 2019
1 parent 216f4d5 commit 9c61ecf
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 12 deletions.
2 changes: 1 addition & 1 deletion doc/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Pygame Zero のバグ報告や機能の要望は `Github issue tracker`_ から
バグ報告などを行う前に留意すべき事項は以下の通りです。

* ほかの人も同じことをしている可能性があります。既存のイシューを検索して(open か closed)に関わらず)ほかの人が既にイシューを登録していないか確認してください。
* 開発者はどのバージョンの Pygame Zero を使っているのか、動かしている OS ((Windows, Mac, Linux 等) とそのバージョン(Windows 10, Ubuntu 16.04 等)を知る必要があります。
* 開発者はどのバージョンの Pygame Zero を使っているのか、動かしている OS (Windows, Mac, Linux 等) とそのバージョン(Windows 10, Ubuntu 16.04 等)を知る必要があります。

.. _`Github issue tracker`: https://github.com/lordmauve/pgzero/issues

Expand Down
2 changes: 1 addition & 1 deletion doc/other-libs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ GPIO Zero
`GPIO Zero`_ は `Raspberry Pi`_ の General Purpose Input/Output (GPIO)
ピンに接続されたデバイスを制御するためのライブラリです。

GPIO Zero 自体が独自のスレッドで動作するため、問題なく Pygame Zero と組み合わせて使うことができます
GPIO Zero 自体が独自のスレッドで動作するため、Pygame Zero と一緒に問題なく使うことができます

.. caution::

Expand Down
2 changes: 1 addition & 1 deletion doc/principles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Pygame Zero は Pygame をほぼ完全にラップしたものです。しかし
実行時のコストを最小化する
--------------------------

つまるところ、Pygame Zero はゲームのフレームワークですからパフォーマンスは問題となります
つまるところ、Pygame Zero はゲームのフレームワークですからパフォーマンスはとても重要です

潜在的な落とし穴を塞ぐため、フレーム毎にコストの高いチェックを行うのは、現実には受け入れ難いことです。その代わり、起動時に確認、または例外が発生した場合にのみ確認して診断の詳細を出力するようにします。

Expand Down
18 changes: 10 additions & 8 deletions doc/roadmap.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
ロードマップ
============

Pygame Zero はオープンソースのプロジェクトです。他のオープンソース・プロジェクトと同様、開発ロードマップは変更する可能性があります
Pygame Zero はオープンソースのプロジェクトです。他のオープンソース・プロジェクトと同様、開発ロードマップは変更になる可能性があります

このドキュメントは将来のリリースのためのいくつかの目標を掲載していますが、 **その目標が達成される保証はありません** 。

翻訳
----

Pygame Zero は若いユーザーを対象にしています。しかし、若いユーザーはドキュメントが自分の言語で提供されていないと、英語版を読む力まだないことがあります
Pygame Zero は若いユーザーを対象にしています。しかし、若いユーザーの場合、ドキュメントが自分の言語で提供されていないと、英語版を読むだけの力がまだないことがあります

ドキュメントの翻訳版を提供することは、新たなユーザーが Pygame Zero を使う上で大きな助けになります。これは多くの人の貢献を必要としている部分です。わたしひとりの語学力で対応しきれるものではありません!

Expand All @@ -22,7 +22,7 @@ Github Issue: `#70 <https://github.com/lordmauve/pgzero/issues/70>`_

スーパーファミコンタイプのゲームコントローラはとても安く販売されています。 `Pi Hut`_ なら数ポンド、 Amazon_ では2個セット、Raspberry Pi とのバンドルで販売されているものもあります。

ゲームコントローラのサポートはこのような特定のモデルだけに留めるべきではありません。今どきのほとんどのゲームコントローラが最低限備えているボタンや方向キーを最小公約数的に扱うべきだと考えています。
ゲームコントローラは特定の機種定のサポートモデルだけに留めるべきではありません。今どきのほとんどのゲームコントローラが最低限備えているボタンや方向キーを最小公約数的に扱うべきだと考えています。

またこの機能は、:ref:`アクセシビリティ` の原則に準じ、Pygame Zero ゲームをプレイするためにゲームコントローラを **必須** としない方法で追加する必要があります。

Expand All @@ -37,9 +37,9 @@ Github Issue: `#71 <https://github.com/lordmauve/pgzero/issues/71>`_

Pygame のエキスパートたちは、おもしろい効果を生み出すためにオフスクリーンの Surface を多用しています。

一方 Pygame Zero スクリーン Surface だけをサポートする方法を選択しました。これは描画などを行うリッチな API ``Screen`` にラップして提供されています。
一方 Pygame Zero はスクリーン Surface だけをサポートする方法を選択しました。これは描画などを行うリッチな API である ``Screen`` にラップして提供されています。

しかしこのため、簡単に Surface を追加できなくなっています。この点からすると、 Pygame Zero はひどく使いにくいものになっています。
しかしこれによって、後から簡単に Surface を追加することができなくなっています。この件に関していえば Pygame Zero はひどく使いにくいものになっています。

Pygame Zero の Actor と Screen でうまく機能するカスタム Surface の追加方法を用意する必要があります。

Expand All @@ -48,12 +48,14 @@ Pygame Zero の Actor と Screen でうまく機能するカスタム Surface

.. caution::

:ref:`ストレージ API <data-storage>` は開発が完了しており Pygame Zero 1.3 から提供される予定となっています。
`ストレージ API`_ は開発が完了しており Pygame Zero 1.3 から提供される予定となっています。

.. _`ストレージ API`: builtins.html#data_storage

Github Issue: `#33 <https://github.com/lordmauve/pgzero/issues/33>`_

データの保存やロードに役立つ機能です。

すぐに思いつくのはゲームを保存することですが、ゲーム全体を保存してロードするのはかなり難しくなってしまうことがあります。より簡単な使い方は設定、カスタマイズ内容、ハイスコア、到達したレベルなどを保存することです。
すぐに思いつくのはゲームを保存することですが、ゲームを丸ごと保存してロードするのはかなり難しいかもしれません。より簡単な使い方は設定、カスタマイズ内容、ハイスコア、到達したレベルなどを保存することです。

もちろん Python は標準でファイルを読み書きするための API を備えていますが、こちらには先生が直ちに教えることを躊躇してしまうような複雑さがあります
もちろん Python は標準でファイルを読み書きするための API を備えていますが、こちらには先生が直ちに教えることをためらってしまう複雑さがあります
2 changes: 1 addition & 1 deletion doc/stickers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
:align: center
:target: https://www.stickermule.com/supports/opensource

ノートパソコンのステッカーは Pygame Zero の宣伝になるだけではなく、生徒たちが Pygame Zero に触れ、学ぶことのモチベーションを上げる最適な方法です
ノートパソコンのステッカーは Pygame Zero の宣伝になるだけではなく、生徒たちが Pygame Zero に触れ、学習のモチベーションを上げる最適な方法です

ステッカーのデザインはこのようになっています(実物とはサイズが違います)。

Expand Down

0 comments on commit 9c61ecf

Please sign in to comment.