diff --git a/README.md b/README.md index cf63f40..6e63d42 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Open COBOL ESQL 4J +[日本語版README](./README_JP.md) + Open COBOL ESQL 4J (OCESQL 4J) consits of open-source Embedded SQL pre-compiler and run time libraries for [opensource COBOL 4J](https://github.com/opensourcecobol/opensourcecobol4j). # Supported software versions @@ -20,7 +22,7 @@ Open COBOL ESQL 4J (OCESQL 4J) consits of open-source Embedded SQL pre-compiler ## Requirements * Open-source database. - OCESQL 4J currently supports PostgreSQL database only. + * OCESQL 4J currently supports PostgreSQL database only. * [opensource COBOL 4j](https://github.com/opensourcecobol/opensourcecobol4j) v1.1.12 or later. @@ -31,9 +33,9 @@ Open COBOL ESQL 4J (OCESQL 4J) consits of open-source Embedded SQL pre-compiler ### Install opensource COBOL 4J -See [Installation guides of opensource COBOL 4J](https://github.com/opensourcecobol/opensourcecobol4j/wiki). +See [README.md of opensource COBOL 4J](https://github.com/opensourcecobol/opensourcecobol4j/blob/develop/README.md). -### Download the content +###D Download the content Run the following commands to download Open COBOL ESQL 4J. @@ -121,7 +123,7 @@ The Windows version of Open COBOL ESQL 4J uses the CL compiler included in Visua #### Build a solution file -1. Download the complete set of files for opensource COBOL 4J. +1. Download the complete set of files for [opensource COBOL 4J](https://github.com/opensourcecobol/opensourcecobol4j). 2. Open win/ocesql.sln with Visual Studio. 3. Select "Debug" or "Release" mode. ![alt text](image/readme1.png) @@ -156,9 +158,10 @@ After the build is completed, "cobj.exe" will be created in `win\x64\Debug` or ` | ocesql.exe | C:\ocesql4j\bin | | ocesql4j.jar | C:\ocesql4j\lib | -* If you want to change the location of the files, modify "install.ps1". +* If you want to change the location of the files, modify "install.ps1". #### Set the environment variables + 1. Add `C:\ocesql4j\bin` to "PATH". 2. Add `C:\ocesql4j\lib\ocesql4j.jar` and `C:\ocesql4j\lib\postgresql.jar` to "CLASSPATH". diff --git a/README_JP.md b/README_JP.md new file mode 100644 index 0000000..3608fe6 --- /dev/null +++ b/README_JP.md @@ -0,0 +1,175 @@ +# Open COBOL ESQL 4J + +[English version README](./README.md) + +Open COBOL ESQL 4Jは[opensource COBOL 4J](https://github.com/opensourcecobol/opensourcecobol4j)向けの埋め込みSQLで、 +埋め込みSQLプリコンパイラと実行時ライブラリで構成されています。 + +# サポートされているソフトウェアのバージョン + +* opensource COBOL 4J + * 1.1.2 or later +* PostgreSQL + * 9.6 + * 15 +* OS + * Ubuntu 24.04 + * Almalinux 9 +* Java + * OpenJDK 11 + +# インストール方法と使用方法 + +## 必須ソフトウェア + +* データベース + Open COBOL ESQL 4Jは現在、PostgreSQLデータベースのみをサポートしています。 + +* [opensource COBOL 4J](https://github.com/opensourcecobol/opensourcecobol4j) v1.1.12 or later. + +* [sbt](https://www.scala-sbt.org/). + + +## インストール(Linux) + +### opensource COBOL 4Jをインストールする + +[opensource COBOL 4JのREADME.md](https://github.com/opensourcecobol/opensourcecobol4j/blob/develop/README_JP.md)を参照してください。 + +### ファイルのダウンロード + +下記のコマンドを実行してOpen COBOL ESQL 4Jをダウンロードします。 + +```sh +curl -L -o Open-COBOL-ESQL-4j-v1.1.1.tar.gz https://github.com/opensourcecobol/Open-COBOL-ESQL-4j/archive/refs/tags/v1.1.1.tar.gz +tar zxvf Open-COBOL-ESQL-4j-v1.1.1.tar.gz +# If you don't need the downloaded file, you can delete it. +rm Open-COBOL-ESQL-4j-v1.1.1.tar.gz +``` + +### jarファイルの準備 + +下記の2つのjarファイルを用意します。 + +#### `libcobj.jar` + +下記のコマンドを実行してください。 + +```sh +cd Open-COBOL-ESQL-4j-1.1.1/ +cp /usr/lib/opensourcecobol4j/libcobj.jar dblibj/lib/ +``` + +opensource COBOL 4Jをインストール済みの場合、`/usr/lib/opensourcecobol4j/libcobj.jar`が存在します。 +`find /usr/lib/ -name libcobj.jar`を実行して上記のパスが表示されることを確認してください。 + +#### `postgresql.jar` + +下記のコマンドを実行してPostgreSQL JDBCドライバを用意します。 + +権限不足でコマンドが実行できない場合は、`sudo`を付けて実行してください。 + +```sh +# Move to the root directory of Open-COBOL-ESQL-4j +cd Open-COBOL-ESQL-4j-1.1.1/ +mkdir -p /usr/lib/Open-COBOL-ESQL-4j-1.1.1/ +curl -L -o /usr/lib/Open-COBOL-ESQL-4j-1.1.1/postgresql.jar https://jdbc.postgresql.org/download/postgresql-42.2.24.jar +cp /usr/lib/Open-COBOL-ESQL-4j-1.1.1/postgresql.jar dblibj/lib +``` + +### sbt + +[公式ガイド](https://www.scala-sbt.org/1.x/docs/Installing-sbt-on-Linux.html)を参照してください。 + +### Open COBOL ESQL 4Jのインストール + +下記のコマンドを実行してください。 + +```sh +./configure --prefix=/usr/ +make +make install +``` + +### `$CLASSPATH`の設定 + +`/usr/lib/Open-COBOL-ESQL-4j/ocesql4j.jar`と`/usr/lib/Open-COBOL-ESQL-4j/postgresql.jar`を環境変数$CLASSPATHに追加してください。 + +```sh +export CLASSPATH="$CLASSPATH":/usr/lib/Open-COBOL-ESQL-4j/ocesql4j.jar:/usr/lib/Open-COBOL-ESQL-4j/postgresql.jar +``` + +## インストール(Windows) +### opensource COBOL 4Jのインストール + +[opensource COBOL 4JのREADME_JP.md](https://github.com/opensourcecobol/opensourcecobol4j/blob/develop/README_JP.md). + +### jarファイルの準備 + +opensource COBOL 4Jのインストール時に作成された`libcobj.jar`を`dblibj\lib`にコピーします。 +さらに、下記のコマンドを実行してPostgreSQL JDBCドライバを用意します。 + +```powershell +cd Open-COBOL-ESQL-4J +mkdir C:\ocesql4j\lib +curl -L -o C:\ocesql4j\lib\postgresql.jar https://jdbc.postgresql.org/download/postgresql-42.2.24.jar +copy C:\ocesql4j\lib\postgresql.jar dblibj\lib +``` + +### sbt + +[ここ](https://www.scala-sbt.org/download/)からダウンロードしてインストールしてください。 + +### Open COBOL ESQL 4Jのインストール + +#### Visual Studioのインストール +Windows版Open COBOL ESQL 4JはVisual Studio 2022に含まれるCLコンパイラを使用するため、事前に[Visual Studio](https://visualstudio.microsoft.com/)をインストールしている必要があります。 + + +#### ソリューションファイルのビルド +1. [opensource COBOL 4J](https://github.com/opensourcecobol/opensourcecobol4j)をダウンロードしてください。 +2. Visual Studioでwin/ocesql.slnを開いてください。 +3. "Debug"モードまたは"Release"モードを選択してください. +![alt text](image/readme1.png) +4. "Build" -> "Build Solution"を選択してください +![alt text](image/readme2.png) + +コンパイルが完了すると、"cobj.exe"が`win\x64\Debug`または`win\x64\Release`に作成されます。 + +#### Scalaファイルのビルド +2. PowerShellを開いてください。 + +3. "dblibj"ディレクトリに移動してください。 + ``` + cd dblibj + ``` +4. 下記のコマンドを実行してください。 + ``` + sbt assembly + ``` + +#### ファイルを配置する +1. デバッグモードでビルドした場合は、"win\install.ps1"の5行目を`\x64\Release\cobj.exe`から`\x64\Debug\cobj.exe`に変更してください。 +2. PowerShellを開いてください。 +3. "win"ディレクトリに移動し、"install.ps1"を実行してください。 + ``` + cd win + .\install.ps1 + ``` +* 各ファイルは以下の場所に配置されます。 + + | File name | Location | + |---|---| + | ocesql.exe | C:\ocesql4j\bin | + | ocesql4j.jar | C:\ocesql4j\lib | + +* もしファイルの場所を変更したい場合は、"install.ps1"を変更してください。 + +#### 環境変数を設定する +1. `C:\ocesql4j\bin`を環境変数"PATH"に追加してください。 +2. `C:\ocesql4j\lib\ocesql4j.jar`と`C:\ocesql4j\lib\postgresql.jar`を環境変数"CLASSPATH"に追加してください。 + +# コントリビュート + +コントリビュータ向けのガイドラインは[CONTRIBUTING_JP.md](./CONTRIBUTING_JP.md)にあります。 +コントリビュータの一覧は、https://github.com/opensourcecobol/Open-COBOL-ESQL-4j/graphs/contributors に掲載されています。