From 5e2c6ce8ac1d25f7e71349cbb14a5f439dccf21a Mon Sep 17 00:00:00 2001 From: Momoko YOKOGAWA Date: Fri, 4 Oct 2024 17:14:47 +0900 Subject: [PATCH 1/5] Update README_JP.md --- README_JP.md | 83 ++++++++++++++++++++++++---------------------------- 1 file changed, 38 insertions(+), 45 deletions(-) diff --git a/README_JP.md b/README_JP.md index d5b5119d..0071cd11 100644 --- a/README_JP.md +++ b/README_JP.md @@ -4,6 +4,7 @@ opensource COBOL 4JはCOBOLソースコードをJavaソースコードに変換するCOBOLコンパイラです. opensource COBOL 4JはCOBOLからCに変換するCOBOLコンパイラ["opensource COBOL"](https://github.com/opensourcecobol/opensource-cobol)をもとに開発されています. +（実際、このリポジトリには多くの[opensource COBOL](https://github.com/opensourcecobol/opensource-cobol)のソースファイルが含まれています.） 変更履歴は[CHANGELOG.md](./CHANGELOG.md)を参照してください. @@ -21,11 +22,7 @@ opensource COBOL 4J は下記の環境でテストされています. 古いバージョンの動作環境については、[doc/requirements-all.md](./doc/requirements-all.md)をご覧ください. -## インストール - -opensource COBOL 4J v1.1.2はUbuntuとAlmaLinuxで動作を確認しています. - -## 手動インストール +## インストール(Linux) ### 依存ライブラリのインストール @@ -52,9 +49,7 @@ dnf -y update dnf install -y java-21-amazon-corretto-devel gcc make bison flex automake autoconf diffutils gettext tar gzip ``` -### opensource COBOL 4Jのインストール (Linux) - -下記のコマンドを実行する +### opensource COBOL 4Jのインストール ``` curl -L -o opensourcecobol4j-v1.1.2.tar.gz https://github.com/opensourcecobol/opensourcecobol4j/archive/refs/tags/v1.1.2.tar.gz @@ -68,7 +63,7 @@ sudo make install ### $CLASSPATHの設定 /usr/lib/opensourcecobol4j/libcobj.jar を 環境変数$CLASSPATH に追加する. -たとえば下記のコードを実行する。 +例えばUnix系システムで下記のコードを実行する。 ```bash export CLASSPATH="$CLASSPATH:/usr/lib/opensourcecobol4j/libcobj.jar" @@ -76,93 +71,93 @@ export CLASSPATH="$CLASSPATH:/usr/lib/opensourcecobol4j/libcobj.jar" 古いバージョンのインストール方法は、[doc/installation_jp](./doc/installation_jp)をご覧ください. -## opensource COBOL 4Jのインストール (Windows) +## インストール (Windows) ### Visual Studioのインストール Windows版のopensource COBOL 4JはVisual Studioに含まれるCLコンパイラを使用します. そのため、まずは[Visual Studio](https://visualstudio.microsoft.com/)をインストールしてください. +### ソリューションファイルのビルド +1. opensource COBOL 4Jのファイル一式をダウンロードする. +2. win/opensourcecobol4j.slnをVisual Studioで開く. +3. ”Debug”または”Release”モードを選択する. + ![alt text](image/readme1.png) +4. ”ビルド” -> ”ソリューションのビルド” を選択する. + ![alt text](image/readme2.png) + ビルドが完了すると、`win/x64/Debug`または`win/x64/Release`に"cobj.exe"が作成される. + ### Javaファイルのビルド 1. JDKをインストールする. -https://www.oracle.com/java/technologies/downloads/?er=221886#java8-windows + https://www.oracle.com/java/technologies/downloads/?er=221886#java8-windows 2. PowerShellを開く. -3. libcobjディレクトリに移動し、`.\gradlew shadowJar`を実行する. +3. "libcobj"ディレクトリに移動し、`.\gradlew shadowJar`を実行する. ``` cd libcobj .\gradlew shadowJar ``` - これにより、"libcobj.jar"が`libcobj\app\build\libs\`に作成される. + これにより、`libcobj\app\build\libs\`に"libcobj.jar"が作成される. -### ソリューションファイルのビルド -1. opensource COBOL 4Jのファイル一式をダウンロードする. -2. win/opensourcecobol4j.slnをVisual Studioで開く. -3. ”Debug”または”Release”モードを選択する. -![alt text](image/readme1.png) -4. ”ビルド” -> ”ソリューションのビルド” を選択する. -![alt text](image/readme2.png) -ビルドが完了したら、`win/x64/Debug`または`win/x64/Release`に"cobj.exe"が生成される. - -### ファイルの配置 -1. Debugモードでビルドした場合、win/make-install.ps1の5行目を`\x64\Release\cobj.exe`から`\x64\Debug\cobj.exe`に変更する. +### ファイルを適切な位置に配置 +1. Debugモードでビルドした場合、`win/make-install.ps1`の5行目を`\x64\Release\cobj.exe`から`\x64\Debug\cobj.exe`に変更する. 2. PowerShellを開く. -3. ”win”ディレクトリに移動し、make-install.ps1を実行する. +3. ”win”ディレクトリに移動し、`make-install.ps1`を実行する. ``` cd win .\make-install.ps1 ``` * ファイルは下記の場所にそれぞれ配置される. -* ファイルの配置場所を変更したい場合は、make-install.ps1に記載してあるパスを編集する. - | ファイル名 | 配置場所 | |---|---| | cobj.exe | C:\opensourcecobol4j\bin | | libcobj.jar | C:\opensourcecobol4j\lib | | configファイル | C:\opensourcecobol4j\config | + +* ファイルの配置場所を変更したい場合は、make-install.ps1に記載してあるパスを編集する. ### 環境変数の設定 -1. 環境変数PATHに`C:\opensourcecobol4j\bin`を追加する. -2. 環境変数CLASSPATHに`C:\opensourcecobol4j\lib\libcobj.jar`を追加する. +1. `C:\opensourcecobol4j\bin`を環境変数PATHに追加する. +2. `C:\opensourcecobol4j\lib\libcobj.jar`を環境変数CLASSPATHに追加する. -## Dockerによるインストール +## Dockerを使ったインストール -opensource COBOL 4J v1.1.2をインストールしたDockerイメージを利用できます. +opensource COBOL 4JのDockerコンテナが利用可能です. ```bash docker pull opensourcecobol/opensourcecobol4j:1.1.2 ``` -コンテナ内で下記のコマンドを実行すると、Hello Worldプログラムをコンパイル&実行できる. +以下のコマンドを実行して、"Hello World"のCOBOLプログラムを実行. ``` bash -# Move to the sample directory +# サンプルディレクトリに移動 $ cd /root/cobol_sample -# Translate COBOL to Java and compile the Java source file. +# COBOLをJavaに変換し、Javaソースファイルをコンパイル $ cobj HELLO.cbl -# Run "Hello World" +# "Hello World"を実行 $ java HELLO HELLO WORLD! ``` ## 使い方 -コンパイル. +コンパイルする. ```bash cobj [COBOL source file] ``` (cobjコマンドにより,カレントディレクトリに[PROGRAM-ID].javaと[PROGRAM-ID].classが生成されます.) -実行. +実行する. ```bash java [PROGRAM-ID] ``` ## ランタイムライブラリのAPIリファレンス -ランタイムライブラリである`libcobj.jar`のAPIリファレンスは[こちら](https://opensourcecobol.github.io/opensourcecobol4j/javadoc/libcobj/index.html)から確認できます。 +ランタイムライブラリ`libcobj.jar`のAPIリファレンスは[こちら](https://opensourcecobol.github.io/opensourcecobol4j/javadoc/libcobj/index.html)から確認できます。 ## 実装状況 -実装済み +実装済み機能： * 基本的なデータ操作 (MOVE, COMPUTE, ... ) * 制御文 (IF, PERFORM, GO TO, ...) @@ -174,14 +169,12 @@ java [PROGRAM-ID] * SORT文 * 組み込み関数 (ACOS, LENGTH, MAX, ...) -## テストのステータス - -### NIST COBOL85 test suite +## NIST COBOL85 test suite opensource COBOL 4Jは[NIST COBOL85 test suite](https://www.itl.nist.gov/div897/ctg/cobol_fo rm.htm)によりテストされています. -主要テスト結果 +主要テスト結果： ``` ------ Directory Information ------- --- Total Tests Information --- @@ -201,7 +194,7 @@ RL 32 32 0 0 1827 0 5 0 1832 Relativ Total 361 361 0 0 8804 0 21 93 8918 ``` -その他のテストの結果 +追加テストの結果： ``` ------ directory information ------- --- total tests information --- @@ -281,5 +274,5 @@ cobj-apiを用いたSpring Bootアプリケーションの作成方法につい ## コントリビューㇳ -コントリビュータの一覧は https://github.com/opensourcecobol/opensourcecobol4j/graphs/contributors に掲載されています. コントリビュータ向けのガイドラインは[CONTRIBUTING_JP.md](./CONTRIBUTING_JP.md)を参照してください. +コントリビュータの一覧は https://github.com/opensourcecobol/opensourcecobol4j/graphs/contributors に掲載されています. From af5f6e2d1a62346f254fa2954115ef783ab69ea2 Mon Sep 17 00:00:00 2001 From: Momoko YOKOGAWA Date: Mon, 7 Oct 2024 14:41:48 +0900 Subject: [PATCH 2/5] Update README_JP.md --- README_JP.md | 105 ++++++++++++++++++++++----------------------------- 1 file changed, 46 insertions(+), 59 deletions(-) diff --git a/README_JP.md b/README_JP.md index 0071cd11..1a7e85b6 100644 --- a/README_JP.md +++ b/README_JP.md @@ -2,55 +2,49 @@ [English version README](./README.md) -opensource COBOL 4JはCOBOLソースコードをJavaソースコードに変換するCOBOLコンパイラです. -opensource COBOL 4JはCOBOLからCに変換するCOBOLコンパイラ["opensource COBOL"](https://github.com/opensourcecobol/opensource-cobol)をもとに開発されています. -（実際、このリポジトリには多くの[opensource COBOL](https://github.com/opensourcecobol/opensource-cobol)のソースファイルが含まれています.） +opensource COBOL 4JはCOBOLソースコードをJavaソースコードに変換するCOBOLコンパイラです。 +opensource COBOL 4JはCOBOLからCソースコードに変換するCOBOLコンパイラ["opensource COBOL"](https://github.com/opensourcecobol/opensource-cobol)をもとに開発されています。 +（実際、このリポジトリには多くの[opensource COBOL](https://github.com/opensourcecobol/opensource-cobol)のソースファイルが含まれています。） -変更履歴は[CHANGELOG.md](./CHANGELOG.md)を参照してください. +変更履歴は[CHANGELOG.md](./CHANGELOG.md)をご覧ください。 ## ライセンス -ランタイムライブラリであるlibcobjはLGPL 3,それ以外のソフトウェアやライブラリはGPL 3の下で配布されています. +ランタイムライブラリであるlibcobjはLGPL 3、それ以外のソフトウェアやライブラリはGPL 3の下で配布されています。 ## 動作環境 - -opensource COBOL 4J は下記の環境でテストされています. +opensource COBOL 4Jは、下記の環境でテストされています： * Ubuntu 24.04 と OpenJDK 21 * AlmaLinux 9 と OpenJDK 11 * Amazon Linux 2023 と OpenJDK 21 -古いバージョンの動作環境については、[doc/requirements-all.md](./doc/requirements-all.md)をご覧ください. +古いバージョンの動作環境については、[doc/requirements-all.md](./doc/requirements-all.md)をご覧ください。 ## インストール(Linux) ### 依存ライブラリのインストール - -下記のコマンドを実行する. +下記のコマンドを実行します。 #### Ubuntu 24.04 - ``` sudo apt-get update sudo apt-get install -y default-jdk build-essential bison flex gettext texinfo libgmp-dev autoconf ``` #### AlmaLinux 9 - ``` dnf -y update dnf install -y java-11-openjdk-devel gcc make bison flex automake autoconf diffutils gettext ``` #### Amazon Linux 2023 - ``` dnf -y update dnf install -y java-21-amazon-corretto-devel gcc make bison flex automake autoconf diffutils gettext tar gzip ``` ### opensource COBOL 4Jのインストール - ``` curl -L -o opensourcecobol4j-v1.1.2.tar.gz https://github.com/opensourcecobol/opensourcecobol4j/archive/refs/tags/v1.1.2.tar.gz tar zxvf opensourcecobol4j-v1.1.2.tar.gz @@ -61,71 +55,69 @@ sudo make install ``` ### $CLASSPATHの設定 - -/usr/lib/opensourcecobol4j/libcobj.jar を 環境変数$CLASSPATH に追加する. -例えばUnix系システムで下記のコードを実行する。 +/usr/lib/opensourcecobol4j/libcobj.jar を 環境変数$CLASSPATH に追加します。 +例えば、Unix系システムで次のコードを実行します。 ```bash export CLASSPATH="$CLASSPATH:/usr/lib/opensourcecobol4j/libcobj.jar" ``` -古いバージョンのインストール方法は、[doc/installation_jp](./doc/installation_jp)をご覧ください. +古いバージョンのインストール方法は、[doc/installation_jp](./doc/installation_jp)をご覧ください。 ## インストール (Windows) ### Visual Studioのインストール -Windows版のopensource COBOL 4JはVisual Studioに含まれるCLコンパイラを使用します. -そのため、まずは[Visual Studio](https://visualstudio.microsoft.com/)をインストールしてください. +Windows版のopensource COBOL 4JはVisual Studioに含まれるCLコンパイラを使用します。 +そのため、まずは[Visual Studio](https://visualstudio.microsoft.com/)をインストールする必要があります。 ### ソリューションファイルのビルド -1. opensource COBOL 4Jのファイル一式をダウンロードする. -2. win/opensourcecobol4j.slnをVisual Studioで開く. -3. ”Debug”または”Release”モードを選択する. +1. opensource COBOL 4Jのファイル一式をダウンロードする。 +2. Visual Studioでwin/opensourcecobol4j.slnを開く。 +3. ”Debug”または”Release”モードを選択する。 ![alt text](image/readme1.png) -4. ”ビルド” -> ”ソリューションのビルド” を選択する. +4. ”ビルド” -> ”ソリューションのビルド” を選択する。 ![alt text](image/readme2.png) - ビルドが完了すると、`win/x64/Debug`または`win/x64/Release`に"cobj.exe"が作成される. + ビルドが完了すると、`win/x64/Debug`または`win/x64/Release`に"cobj.exe"が作成される。 ### Javaファイルのビルド -1. JDKをインストールする. +1. JDKをインストールする。 https://www.oracle.com/java/technologies/downloads/?er=221886#java8-windows -2. PowerShellを開く. -3. "libcobj"ディレクトリに移動し、`.\gradlew shadowJar`を実行する. +2. PowerShellを開く。 +3. "libcobj"ディレクトリに移動し、`.\gradlew shadowJar`を実行する。 ``` cd libcobj .\gradlew shadowJar ``` - これにより、`libcobj\app\build\libs\`に"libcobj.jar"が作成される. + これにより、`libcobj\app\build\libs\`に"libcobj.jar"が作成される。 ### ファイルを適切な位置に配置 -1. Debugモードでビルドした場合、`win/make-install.ps1`の5行目を`\x64\Release\cobj.exe`から`\x64\Debug\cobj.exe`に変更する. -2. PowerShellを開く. -3. ”win”ディレクトリに移動し、`make-install.ps1`を実行する. +1. Debugモードでビルドした場合、`win/make-install.ps1`の5行目を`\x64\Release\cobj.exe`から`\x64\Debug\cobj.exe`に変更する。 +2. PowerShellを開く。 +3. ”win”ディレクトリに移動し、`make-install.ps1`を実行する。 ``` cd win .\make-install.ps1 ``` -* ファイルは下記の場所にそれぞれ配置される. +* 各ファイルは以下の場所に配置されます。 | ファイル名 | 配置場所 | |---|---| | cobj.exe | C:\opensourcecobol4j\bin | | libcobj.jar | C:\opensourcecobol4j\lib | | configファイル | C:\opensourcecobol4j\config | -* ファイルの配置場所を変更したい場合は、make-install.ps1に記載してあるパスを編集する. +* ファイルの配置場所を変更したい場合は、`make-install.ps1`に記載してあるパスを編集してください。 ### 環境変数の設定 -1. `C:\opensourcecobol4j\bin`を環境変数PATHに追加する. -2. `C:\opensourcecobol4j\lib\libcobj.jar`を環境変数CLASSPATHに追加する. +1. `C:\opensourcecobol4j\bin`を環境変数PATHに追加する。 +2. `C:\opensourcecobol4j\lib\libcobj.jar`を環境変数CLASSPATHに追加する。 ## Dockerを使ったインストール - -opensource COBOL 4JのDockerコンテナが利用可能です. +opensource COBOL 4JのDockerコンテナを利用できます。 ```bash docker pull opensourcecobol/opensourcecobol4j:1.1.2 ``` -以下のコマンドを実行して、"Hello World"のCOBOLプログラムを実行. +以下のコマンドを実行して、"Hello World"のCOBOLプログラムを実行します。 ``` bash # サンプルディレクトリに移動 @@ -140,39 +132,35 @@ HELLO WORLD! ``` ## 使い方 - -コンパイルする. +コンパイルします。 ```bash cobj [COBOL source file] ``` -(cobjコマンドにより,カレントディレクトリに[PROGRAM-ID].javaと[PROGRAM-ID].classが生成されます.) +(cobjコマンドにより、カレントディレクトリに[PROGRAM-ID].javaと[PROGRAM-ID].classが生成されます。) -実行する. +実行します。 ```bash java [PROGRAM-ID] ``` -## ランタイムライブラリのAPIリファレンス +## ランタイムライブラリのAPIリファレンス ランタイムライブラリ`libcobj.jar`のAPIリファレンスは[こちら](https://opensourcecobol.github.io/opensourcecobol4j/javadoc/libcobj/index.html)から確認できます。 ## 実装状況 - 実装済み機能： - -* 基本的なデータ操作 (MOVE, COMPUTE, ... ) -* 制御文 (IF, PERFORM, GO TO, ...) -* DISPLAY文, ACCEPT文 +* 基本的なデータ操作 (MOVE, COMPUTEなど) +* 制御文 (IF, PERFORM, GO TOなど) +* 一部のI/O機能 (DISPLAY, ACCEPTなど) * CALLによる呼び出し * SEQUENTIALファイルの入出力機能 * RELATIVEファイルの入出力機能 * INDEXEDファイルの入出力機能 * SORT文 -* 組み込み関数 (ACOS, LENGTH, MAX, ...) - -## NIST COBOL85 test suite +* 組み込み関数 (ACOS, LENGTH, MAXなど) +## NIST85テストの状況 opensource COBOL 4Jは[NIST COBOL85 test suite](https://www.itl.nist.gov/div897/ctg/cobol_fo -rm.htm)によりテストされています. +rm.htm)によりテストされています。 主要テスト結果： @@ -207,7 +195,7 @@ rw 4 0 4 0 0 0 0 0 0 REPORT total 21 0 21 0 0 0 0 0 0 ``` ## cobj-idx -`cobj-idx` コマンドはINDEXEDファイルを扱うためのユーティリティで、opensource COBOL 4Jの一部としてインストールされます. +`cobj-idx`コマンドはINDEXEDファイルを扱うためのユーティリティで、opensource COBOL 4Jをインストールする際に、一緒にインストールされます。 ``` cobj-idx - A utility tool to handle an indexed file of opensource COBOL 4J @@ -256,7 +244,7 @@ Options: ``` ## cobj-api -cobj-apiコマンドを使用することで、`cobj`で生成されたプログラムを呼び出すSpring boot向けのJavaファイルを簡単に生成できます. +`cobj-api`コマンドを使用することで、`cobj`で生成されたプログラムを呼び出すSpring boot向けのJavaファイルを簡単に生成できます。 ``` Usage: cobj-api [options] @@ -270,9 +258,8 @@ Options: -o=, --output-dir= Set the output destination of the java file to an arbitrary destination -v, --version Prints the version of the cobj-api ``` -cobj-apiを用いたSpring Bootアプリケーションの作成方法については、[こちら](./doc/cobj-api_SpringBoot_JP.md)を参照してください。 +cobj-apiを用いたSpring Bootアプリケーションの作成方法については、[こちら](./doc/cobj-api_SpringBoot_JP.md)をご覧ください。 ## コントリビューㇳ - -コントリビュータ向けのガイドラインは[CONTRIBUTING_JP.md](./CONTRIBUTING_JP.md)を参照してください. -コントリビュータの一覧は https://github.com/opensourcecobol/opensourcecobol4j/graphs/contributors に掲載されています. +コントリビュータ向けのガイドラインは[CONTRIBUTING_JP.md](./CONTRIBUTING_JP.md)を参照してください。 +コントリビュータの一覧は https://github.com/opensourcecobol/opensourcecobol4j/graphs/contributors に掲載されています。 From ff312bef0bfdaf8c98a91af85f66f8a201137825 Mon Sep 17 00:00:00 2001 From: Momoko YOKOGAWA Date: Mon, 7 Oct 2024 14:43:40 +0900 Subject: [PATCH 3/5] Update README_JP.md --- README_JP.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README_JP.md b/README_JP.md index 1a7e85b6..4bfcee41 100644 --- a/README_JP.md +++ b/README_JP.md @@ -2,9 +2,9 @@ [English version README](./README.md) -opensource COBOL 4JはCOBOLソースコードをJavaソースコードに変換するCOBOLコンパイラです。 -opensource COBOL 4JはCOBOLからCソースコードに変換するCOBOLコンパイラ["opensource COBOL"](https://github.com/opensourcecobol/opensource-cobol)をもとに開発されています。 -（実際、このリポジトリには多くの[opensource COBOL](https://github.com/opensourcecobol/opensource-cobol)のソースファイルが含まれています。） +"opensource COBOL 4J"は、COBOLソースコードをJavaソースコードに変換するCOBOLコンパイラです。 +"opensource COBOL 4J"は、COBOLからCソースコードに変換するCOBOLコンパイラ["opensource COBOL"](https://github.com/opensourcecobol/opensource-cobol)をもとに開発されています。 +（実際、このリポジトリには多くの["opensource COBOL"](https://github.com/opensourcecobol/opensource-cobol)のソースファイルが含まれています。） 変更履歴は[CHANGELOG.md](./CHANGELOG.md)をご覧ください。 From 3eb91c75f131d2341aae8188969580d327fb5265 Mon Sep 17 00:00:00 2001 From: Momoko YOKOGAWA Date: Mon, 7 Oct 2024 14:46:20 +0900 Subject: [PATCH 4/5] Update README_JP.md --- README_JP.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_JP.md b/README_JP.md index 4bfcee41..f25fd3aa 100644 --- a/README_JP.md +++ b/README_JP.md @@ -55,7 +55,7 @@ sudo make install ``` ### $CLASSPATHの設定 -/usr/lib/opensourcecobol4j/libcobj.jar を 環境変数$CLASSPATH に追加します。 +/usr/lib/opensourcecobol4j/libcobj.jarを環境変数$CLASSPATHに追加します。 例えば、Unix系システムで次のコードを実行します。 ```bash From 2d6ce055f249b6e29b5484cc36574c97ef27ddcb Mon Sep 17 00:00:00 2001 From: Momoko YOKOGAWA Date: Mon, 7 Oct 2024 16:42:14 +0900 Subject: [PATCH 5/5] Update README_JP.md --- README_JP.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README_JP.md b/README_JP.md index f25fd3aa..7509d4fa 100644 --- a/README_JP.md +++ b/README_JP.md @@ -159,8 +159,7 @@ java [PROGRAM-ID] * 組み込み関数 (ACOS, LENGTH, MAXなど) ## NIST85テストの状況 -opensource COBOL 4Jは[NIST COBOL85 test suite](https://www.itl.nist.gov/div897/ctg/cobol_fo -rm.htm)によりテストされています。 +opensource COBOL 4Jは[NIST COBOL85 test suite](https://www.itl.nist.gov/div897/ctg/cobol_form.htm)によりテストされています。 主要テスト結果：