Merge pull request #171 from chvmvd/update-readme

Author: chvmvd

README-ja.md

@@ -0,0 +1,47 @@
+[![Build and Deploy](https://github.com/sikepuri-algorithm/sikepuri-algorithm.github.io/actions/workflows/deploy.yml/badge.svg)](https://github.com/sikepuri-algorithm/sikepuri-algorithm.github.io/actions/workflows/deploy.yml) [![Super Linter](https://github.com/sikepuri-algorithm/sikepuri-algorithm.github.io/actions/workflows/super_linter.yml/badge.svg)](https://github.com/sikepuri-algorithm/sikepuri-algorithm.github.io/actions/workflows/super_linter.yml) [![Formatter](https://github.com/sikepuri-algorithm/sikepuri-algorithm.github.io/actions/workflows/formatter.yml/badge.svg)](https://github.com/sikepuri-algorithm/sikepuri-algorithm.github.io/actions/workflows/formatter.yml) [![Linter](https://github.com/sikepuri-algorithm/sikepuri-algorithm.github.io/actions/workflows/linter.yml/badge.svg)](https://github.com/sikepuri-algorithm/sikepuri-algorithm.github.io/actions/workflows/linter.yml)
+
+<div style="text-align: center">
+    <img src="./static/img/logo-black.svg" alt="logo" height="200px" >
+</div>
+
+[English README is here.](./README.md)
+
+# Introduction to Algorithms
+
+これは、アルゴリズム入門のシケプリです。[こちら](https://sikepuri-algorithm.github.io/)から見ることができます。
+
+[Docusaurus](https://docusaurus.io/) を使って作っています。
+
+## 環境構築
+
+Node.js がインストールされていることを前提とします。
+
+次のコマンドで必要なパッケージをインストールできます。
+
+```shell
+npm ci
+```
+
+以下は、コミット時に自動で Formatter や Linter を実行させるためのスクリプトです。実行しなくて構いません。
+
+```shell
+# Poetry のインストール
+curl -sSL https://install.python-poetry.org | python3 -
+
+# Poetry のパッケージのインストール
+poetry install
+# pre-commit のパッケージのインストール
+poetry run pre-commit install
+```
+
+## 開発
+
+次を実行すると、ローカルサーバーが立ち上がり、プレビューが表示されます。
+
+```shell
+npm start
+```
+
+## コントリビューション
+
+誤植などがありましたら、Issue や PR などで気軽に教えてください。

README.md

@@ -4,42 +4,40 @@
     <img src="./static/img/logo-black.svg" alt="logo" height="200px" >
 </div>
 
-# Introduction to Algorithms
+[日本語版 README はこちら](./README-ja.md)
 
-これは、アルゴリズム入門のシケプリです。デプロイ先は[こちら](https://sikepuri-algorithm.github.io/)
+# Introduction to Algorithms
 
-[Docusaurus](https://docusaurus.io/) を使って作っています。
+This is a document that summarizes the Introduction to Algorithms class. To see the content, visit [here](https://sikepuri-algorithm.github.io/).
 
-## 環境構築
+This site is built using [Docusaurus](https://docusaurus.io/), a modern static site generator.
 
-Node.js のインストール
+## Installation
 
 ```shell
 npm ci
 ```
 
-以下は、コミット時に自動で Formatter や Linter を実行させるためのスクリプトです。実行しなくても構いません。
-
-Poetry をインストールしていなかったら、次を実行
+To run formatter or linter before committing, run the script below. You don't have to run this script.
 
 ```shell
+# Install Poetry
 curl -sSL https://install.python-poetry.org | python3 -
-```
 
-```shell
+# Install Poetry packages
 poetry install
-```
-
-```shell
+# Install pre-commit packages
 poetry run pre-commit install
 ```
 
-## 開発
+## Local Development
+
+This command starts a local development server and opens up a browser window.
 
 ```shell
 npm start
 ```
 
-## その他
+## Contributions
 
-間違いなどがありましたら、Issue や PR などで教えてください。
+Issue or PR is always welcome.