Skip to content

Commit 75e47e9

Browse files
committed
Complete README.rst
1 parent 0d1429f commit 75e47e9

1 file changed

Lines changed: 51 additions & 13 deletions

File tree

README.rst

Lines changed: 51 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,39 @@
11
GMT 教學手冊 (GMT Tutorials)
2-
======================================
2+
========================================
33

44
`網站 (中文) <http://gmt-tutorials.org>`_
55

66
`Website (English) <http://gmt-tutorials.org/en/>`_
77

88
有關於此儲存庫 (About This Repository)
9-
======================================
9+
========================================
1010

11-
本儲存庫為「GMT 教學手冊」網站的文本檔,以 *re*\ **Structured**\ :sup:`Text` 格式撰寫而成,\
11+
這裡為「GMT 教學手冊」網站的文本檔,以 *re*\ **Structured**\ :sup:`Text` 格式撰寫而成,\
1212
再以 `Sphinx <http://www.sphinx-doc.org/en/stable/index.html>`_ 建立。
1313

14-
``Sphinx`` 與相關的 ``Python`` 模組均建立在 `Anaconda 4.0.0 <https://www.continuum.io/downloads>` 之下
14+
Sphinx 與相關的 Python 模組均透過 `Anaconda 4.0.0 <https://www.continuum.io/downloads>`_ 安裝
1515

1616
- ``xxx.rst``: 各章節文檔
17-
- ``xxx/``: 各章節所需的圖片以及最終的 bash 腳本
17+
- ``xxx/``: 各章節所需的圖片、輸入檔以及最終的 bash 腳本
1818
- ``_template/``: favicon 放在這
1919
- ``_static/``: 在 sphinx 標準構築之外額外的 html、javascript 以及 css 程式碼片段
2020
- ``locale/en/``: 英文翻譯檔
2121

22+
Here are the source and text files for the website "GMT Tutorials". All the text is written
23+
in *re*\ **Structured**\ :sup:`Text` format. The website is built using
24+
`Sphinx <http://www.sphinx-doc.org/en/stable/index.html>`_.
25+
26+
Sphinx itself and all related Python modules are installed through
27+
`Anaconda 4.0.0 <https://www.continuum.io/downloads>`_.
28+
29+
- ``xxx.rst``: text file for each chapter (webpage)
30+
- ``xxx/``: figures, sources for plotting, and the final bash script for each chapter
31+
- ``_template/``: favicons are right there
32+
- ``_static/``: additional html, javascript and css snippets after the Sphinx standard build
33+
- ``locale/en/``: English translation files
34+
2235
簡介 (Introduction)
23-
======================================
36+
========================================
2437

2538
**GMT** (**Generic Mapping Tools**, 通常譯成「**通用製圖工具**」) 是一套開放的地理繪圖軟體。與一般\
2639
的地理繪圖軟體如 QGIS、ArcGIS 最大的不同是,GMT 完全可以在命令列介面底下運行。對於有大量\
@@ -33,23 +46,48 @@ GMT 的命令列風格令上手曲線顯得相當陡峭,使得許多想接觸
3346
如果有什麼想分享的評論或使用秘訣,非常歡迎在各章節中留言或直接與\ `<https://www.facebook.com/whyjz>`_\ 聯繫。\
3447
祝各位都能在閱讀的過程中,享受到使用 GMT 畫地圖的樂趣!
3548

36-
編譯文本
37-
======================================
49+
**Generic Mapping Tools** (**GMT**) is a set of open-source software for
50+
mapping and plotting geographic data. It features a command-line
51+
interface, which makes it completely different from the common GIS
52+
software like QGIS or ArcGIS. For those who need to deal with a lot of
53+
plotting tasks, or want to write a script for handling all these jobs,
54+
GMT is extremely worth learning; however, The command-line style of GMT
55+
syntax would be very challenging and makes the learning curve very steep,
56+
especially for beginners who are not familiar with manipulating
57+
geographic data and mapping.
58+
59+
In this tutorials, we will introduce the basic GMT knowledge and many useful
60+
tips from numerous exmaples. The final goal for each chapter is always to finish
61+
a well-designated map or figure. The tutorials are basically written from introductory
62+
level to more advanced techniques, but the materials for each chapeter is also
63+
independent. If you have never heard what the GMT is, it would be a good start
64+
from the most beginning of this tutorials; but if you are already a seasoned GMT
65+
user, please jump to the chapter you're interested to save your time. If you have any
66+
comments and tips and want to share with everybody, please feel free to leave a message
67+
below any chapters, or send it to `me <https://www.facebook.com/whyjz>`_ at any time.
68+
I hope you guys could enjoy the fun plotting using GMT from this tutorials!
69+
70+
編譯文本 (How to build the files to html)
71+
========================================
3872

3973
.. code-block:: bash
4074
41-
# 編譯中文文本
75+
# 編譯中文文本 (build Chinese html)
4276
make html
43-
# 文本會產生在 ``_build/html/`` 底下
77+
# 文本會產生在 _build/html/ 底下
78+
# html would be put under _build/html/
4479
45-
# 編譯英文文本
80+
# 編譯英文文本 (make English html)
4681
make gettext
4782
sphinx-intl update -p _build/locale -l en
4883
# (前往 locale/en/ 翻譯文檔)
84+
# (Go to locate/en/ and translate them)
4985
make -e SPHINXOPTS="-D language='en'" BUILDSURFIX="/en" html
50-
# 文本會產生在 ``_build/html/en/`` 底下
86+
# 文本會產生在 _build/html/en/ 底下
87+
# html would be put under _build/html/en/
5188
52-
# 修改 CSS 與為添加額外的欄位
89+
# 修改 CSS 與添加額外的網頁設計 (Modify CSS and add more web design)
5390
bash decorate.bash
5491
5592
# 完成!
93+
# Finished!!

0 commit comments

Comments
 (0)