mirror of
https://github.com/erg-lang/erg.git
synced 2025-07-07 21:25:31 +00:00
Update dev guide
This commit is contained in:
parent
493492d0db
commit
a76da9feb2
18 changed files with 138 additions and 52 deletions
6
doc/EN/dev_guide/README.md
Normal file
6
doc/EN/dev_guide/README.md
Normal file
|
@ -0,0 +1,6 @@
|
|||
# Erg development guide
|
||||
|
||||
This document is a guide to developing the Erg project.
|
||||
It describes the internal structure of the erg compiler, how to make contributions, guidelines for development, and how to set up the development environment, etc.
|
||||
|
||||
You can read the HTML version at [here](https://erg-lang.org/dev-guide/JA).
|
22
doc/EN/dev_guide/SUMMARY.md
Normal file
22
doc/EN/dev_guide/SUMMARY.md
Normal file
|
@ -0,0 +1,22 @@
|
|||
# Summary
|
||||
|
||||
<!--
|
||||
This file is generated automatically. If you want to edit this, edit `doc/sync_to_summary.py`
|
||||
This file is for generating The Erg Book. Do not add badges, etc.
|
||||
-->
|
||||
|
||||
[about this guide](./about.md)
|
||||
|
||||
---
|
||||
|
||||
- [branch policy](branches.md)
|
||||
- [build features](build_features.md)
|
||||
- [directory structure](directories.md)
|
||||
- [document guideline](doc_guideline.md)
|
||||
- [embedding](embedding.md)
|
||||
- [development environment](env.md)
|
||||
- [internationalization](i18n_messages.md)
|
||||
- [Rust code guideline](rust_code_guideline.md)
|
||||
- [test](test.md)
|
||||
- [troubleshooting](troubleshooting.md)
|
||||
- [versioning](version.md)
|
4
doc/EN/dev_guide/about.md
Normal file
4
doc/EN/dev_guide/about.md
Normal file
|
@ -0,0 +1,4 @@
|
|||
# About this guide
|
||||
|
||||
This document is a guide to developing the Erg project.
|
||||
It describes the internal structure of the erg compiler, how to make contributions, guidelines for development, and how to set up the development environment, etc.
|
|
@ -38,9 +38,9 @@ The `{name}` part is Rust's formatting feature that allows you to embed the cont
|
|||
|
||||
Now let's build with the `--features simplified_chinese` option.
|
||||
|
||||
<img src="../../../assets/screenshot_i18n_messages.png" alt='screenshot_i18n_messages'>
|
||||
<img src="https://raw.githubusercontent.com/erg-lang/erg/main/assets/screenshot_i18n_messages.png" alt='screenshot_i18n_messages'>
|
||||
|
||||
You did it, did not you!
|
||||
You did it!
|
||||
|
||||
## FAQs
|
||||
|
||||
|
@ -55,4 +55,4 @@ A: We currently support the following languages:
|
|||
* "simplified_chinese" (Simplified Chinese)
|
||||
* "traditional_chinese" (Traditional Chinese)
|
||||
|
||||
If you would like to add languages other than these, please make a request.
|
||||
If you would like to add languages other than these, please make a request.
|
||||
|
|
|
@ -1,21 +0,0 @@
|
|||
# Index
|
||||
|
||||
## [branches](branches.md)
|
||||
|
||||
## [build_features](build_features.md)
|
||||
|
||||
## [directories](directories.md)
|
||||
|
||||
## [doc_guideline](doc_guideline.md)
|
||||
|
||||
## [env](env.md)
|
||||
|
||||
## [embedding](embedding.md)
|
||||
|
||||
## [i18n_messages](i18n_messages.md)
|
||||
|
||||
## [rust_code_guideline](rust_code_guideline.md)
|
||||
|
||||
## [test](test.md)
|
||||
|
||||
## [troubleshooting](troubleshooting.md)
|
8
doc/JA/dev_guide/README.md
Normal file
8
doc/JA/dev_guide/README.md
Normal file
|
@ -0,0 +1,8 @@
|
|||
# Erg開発ガイド
|
||||
|
||||
[](https://gezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com/default/source_up_to_date?owner=erg-lang&repos=erg&ref=main&path=doc/EN/dev_guide/README.md&commit_hash=64fec7d91494cbb22f89147863db2a8ee81954db)
|
||||
|
||||
本ドキュメントはErgプロジェクトの開発に関するガイドです。
|
||||
ergコンパイラの内部構造や、コントリビューションの方法、開発に関する指針、開発環境のセットアップ方法などを説明しています。
|
||||
|
||||
[こちら](https://erg-lang.org/dev-guide/JA)からHTML版を読むことができます。
|
22
doc/JA/dev_guide/SUMMARY.md
Normal file
22
doc/JA/dev_guide/SUMMARY.md
Normal file
|
@ -0,0 +1,22 @@
|
|||
# 概要
|
||||
|
||||
<!--
|
||||
This file is generated automatically. If you want to edit this, edit `doc/sync_to_summary.py`
|
||||
This file is for generating The Erg Book. Do not add badges, etc.
|
||||
-->
|
||||
|
||||
[このガイドについて](./about.md)
|
||||
|
||||
---
|
||||
|
||||
- [ブランチ運用方針](branches.md)
|
||||
- [build features](build_features.md)
|
||||
- [ディレクトリ構造](directories.md)
|
||||
- [ドキュメントのガイドライン](doc_guideline.md)
|
||||
- [組み込み](embedding.md)
|
||||
- [開発環境](env.md)
|
||||
- [多言語化](i18n_messages.md)
|
||||
- [Rustコードガイドライン](rust_code_guideline.md)
|
||||
- [テスト](test.md)
|
||||
- [トラブルシューティング](troubleshooting.md)
|
||||
- [バージョニング](version.md)
|
4
doc/JA/dev_guide/about.md
Normal file
4
doc/JA/dev_guide/about.md
Normal file
|
@ -0,0 +1,4 @@
|
|||
# このガイドについて
|
||||
|
||||
本ドキュメントはErgプロジェクトの開発に関するガイドです。
|
||||
ergコンパイラの内部構造や、コントリビューションの方法、開発に関する指針、開発環境のセットアップ方法などを説明しています。
|
|
@ -40,7 +40,7 @@ switch_lang!(
|
|||
|
||||
では、`--features simplified_chinese` オプションを付けてビルドしてみましょう。
|
||||
|
||||
<img src="../../../assets/screenshot_i18n_messages.png" alt='screenshot_i18n_messages'>
|
||||
<img src="https://raw.githubusercontent.com/erg-lang/erg/main/assets/screenshot_i18n_messages.png" alt='screenshot_i18n_messages'>
|
||||
|
||||
やりましたね!
|
||||
|
||||
|
|
|
@ -1,23 +0,0 @@
|
|||
# Index
|
||||
|
||||
[](https://gezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com/default/source_up_to_date?owner=erg-lang&repos=erg&ref=main&path=doc/EN/dev_guide/index.md&commit_hash=64fec7d91494cbb22f89147863db2a8ee81954db)
|
||||
|
||||
## [ブランチ](./branches.md)
|
||||
|
||||
## [build_features](./build_features.md)
|
||||
|
||||
## [ディレクトリ構造](./directories.md)
|
||||
|
||||
## [ドキュメントガイドライン](./doc_guideline.md)
|
||||
|
||||
## [開発環境](./env.md)
|
||||
|
||||
## [組み込み](./embedding.md)
|
||||
|
||||
## [メッセージの多言語化](./i18n_messages.md)
|
||||
|
||||
## [Rustコードガイドライン](./rust_code_guideline.md)
|
||||
|
||||
## [テスト](./test.md)
|
||||
|
||||
## [トラブルシューティング](./troubleshooting.md)
|
6
doc/zh_CN/dev_guide/README.md
Normal file
6
doc/zh_CN/dev_guide/README.md
Normal file
|
@ -0,0 +1,6 @@
|
|||
# Erg development guide
|
||||
|
||||
This document is a guide to developing the Erg project.
|
||||
It describes the internal structure of the erg compiler, how to make contributions, guidelines for development, and how to set up the development environment, etc.
|
||||
|
||||
You can read the HTML version at [here](https://erg-lang.org/dev-guide/zh_CN).
|
22
doc/zh_CN/dev_guide/SUMMARY.md
Normal file
22
doc/zh_CN/dev_guide/SUMMARY.md
Normal file
|
@ -0,0 +1,22 @@
|
|||
# Summary
|
||||
|
||||
<!--
|
||||
This file is generated automatically. If you want to edit this, edit `doc/sync_to_summary.py`
|
||||
This file is for generating The Erg Book. Do not add badges, etc.
|
||||
-->
|
||||
|
||||
[about this guide](./about.md)
|
||||
|
||||
---
|
||||
|
||||
- [branch policy](branches.md)
|
||||
- [build features](build_features.md)
|
||||
- [directory structure](directories.md)
|
||||
- [document guideline](doc_guideline.md)
|
||||
- [embedding](embedding.md)
|
||||
- [development environment](env.md)
|
||||
- [internationalization](i18n_messages.md)
|
||||
- [Rust code guideline](rust_code_guideline.md)
|
||||
- [test](test.md)
|
||||
- [troubleshooting](troubleshooting.md)
|
||||
- [versioning](version.md)
|
4
doc/zh_CN/dev_guide/about.md
Normal file
4
doc/zh_CN/dev_guide/about.md
Normal file
|
@ -0,0 +1,4 @@
|
|||
# About this guide
|
||||
|
||||
This document is a guide to developing the Erg project.
|
||||
It describes the internal structure of the erg compiler, how to make contributions, guidelines for development, and how to set up the development environment, etc.
|
|
@ -39,7 +39,7 @@ switch_lang!(
|
|||
|
||||
现在,我们使用选项构建它
|
||||
|
||||
<img src="../../../assets/screenshot_i18n_messages.png" alt='screenshot_i18n_messages'>
|
||||
<img src="https://raw.githubusercontent.com/erg-lang/erg/main/assets/screenshot_i18n_messages.png" alt='screenshot_i18n_messages'>
|
||||
|
||||
你做到了!
|
||||
|
||||
|
@ -54,4 +54,4 @@ Q: 如果想添加自己的语言,该如何替换部分?答: 目前支持以
|
|||
* "simplified_chinese" (简体中文)
|
||||
* "traditional_chinese" (繁体中文)
|
||||
|
||||
如果你想添加其他语言,请提出请求。
|
||||
如果你想添加其他语言,请提出请求。
|
||||
|
|
6
doc/zh_TW/dev_guide/README.md
Normal file
6
doc/zh_TW/dev_guide/README.md
Normal file
|
@ -0,0 +1,6 @@
|
|||
# Erg development guide
|
||||
|
||||
This document is a guide to developing the Erg project.
|
||||
It describes the internal structure of the erg compiler, how to make contributions, guidelines for development, and how to set up the development environment, etc.
|
||||
|
||||
You can read the HTML version at [here](https://erg-lang.org/dev-guide/zh_TW).
|
22
doc/zh_TW/dev_guide/SUMMARY.md
Normal file
22
doc/zh_TW/dev_guide/SUMMARY.md
Normal file
|
@ -0,0 +1,22 @@
|
|||
# Summary
|
||||
|
||||
<!--
|
||||
This file is generated automatically. If you want to edit this, edit `doc/sync_to_summary.py`
|
||||
This file is for generating The Erg Book. Do not add badges, etc.
|
||||
-->
|
||||
|
||||
[about this guide](./about.md)
|
||||
|
||||
---
|
||||
|
||||
- [branch policy](branches.md)
|
||||
- [build features](build_features.md)
|
||||
- [directory structure](directories.md)
|
||||
- [document guideline](doc_guideline.md)
|
||||
- [embedding](embedding.md)
|
||||
- [development environment](env.md)
|
||||
- [internationalization](i18n_messages.md)
|
||||
- [Rust code guideline](rust_code_guideline.md)
|
||||
- [test](test.md)
|
||||
- [troubleshooting](troubleshooting.md)
|
||||
- [versioning](version.md)
|
4
doc/zh_TW/dev_guide/about.md
Normal file
4
doc/zh_TW/dev_guide/about.md
Normal file
|
@ -0,0 +1,4 @@
|
|||
# About this guide
|
||||
|
||||
This document is a guide to developing the Erg project.
|
||||
It describes the internal structure of the erg compiler, how to make contributions, guidelines for development, and how to set up the development environment, etc.
|
|
@ -39,7 +39,7 @@ switch_lang!(
|
|||
|
||||
現在,我們使用選項構建它
|
||||
|
||||
<img src="../../../assets/screenshot_i18n_messages.png" alt='screenshot_i18n_messages'>
|
||||
<img src="https://raw.githubusercontent.com/erg-lang/erg/main/assets/screenshot_i18n_messages.png" alt='screenshot_i18n_messages'>
|
||||
|
||||
你做到了!
|
||||
|
||||
|
@ -54,4 +54,4 @@ Q: 如果想添加自己的語言,該如何替換部分?答: 目前支持以
|
|||
* "simplified_chinese" (簡體中文)
|
||||
* "traditional_chinese" (繁體中文)
|
||||
|
||||
如果你想添加其他語言,請提出請求。
|
||||
如果你想添加其他語言,請提出請求。
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue