From 79624dcc9f7807017f9485f58b3975ad611d9e55 Mon Sep 17 00:00:00 2001 From: Echo-minn Date: Sun, 7 Apr 2024 13:45:26 +0800 Subject: [PATCH 1/2] feat: add description in README.md about how to install node environment --- README.md | 12 ++++++++++++ docs/README_zh-CN.md | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/README.md b/README.md index 6f151b2..5bf8dfa 100644 --- a/README.md +++ b/README.md @@ -97,8 +97,20 @@ git clone https://github.com/internlm/OpenAOE cd OpenAOE/openaoe/frontend npm install npm run build + +# If you don't have NodeJS or npm, install it by: +# installs NVM (Node Version Manager) +curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash +# download and install Node.js +nvm install 20 +# verifies the right Node.js version is in the environment +node -v # should print `v20.12.1` +# verifies the right NPM version is in the environment +npm -v # should print `10.5.0` ``` +> [!TIP] +> Other latest Node.js versions can be found [here](https://nodejs.org/en/download/package-manager). ### **Start** ```shell diff --git a/docs/README_zh-CN.md b/docs/README_zh-CN.md index a4806c1..c7243a0 100644 --- a/docs/README_zh-CN.md +++ b/docs/README_zh-CN.md @@ -93,8 +93,20 @@ git clone https://github.com/internlm/OpenAOE cd OpenAOE/openaoe/frontend npm install npm run build + +# 如果你没有安装 Node.js，你可以通过以下方式安装：: +# install NVM (Node 版本管理器) +curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash +# 下载并安装 Node.js，可以指定版本 +nvm install 20 +# 验证 Node.js 版本 +node -v # 应该打印 `v20.12.1` +# 验证 NPM 版本 +npm -v # 应该打印 `10.5.0` ``` +> [!TIP] +> 其他Node.js版本可以查询 [Node.js官网](https://nodejs.org/en/download/package-manager)。 ### **运行** ```shell From 0062d970aff6e5d8cd23e720624948284722927f Mon Sep 17 00:00:00 2001 From: Echo-minn Date: Sun, 7 Apr 2024 15:38:05 +0800 Subject: [PATCH 2/2] feat: add .pylintrc --- .pylintrc | 2 ++ README.md | 2 +- docs/README_zh-CN.md | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) create mode 100644 .pylintrc diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..5d3d573 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,2 @@ +[MESSAGES CONTROL] +ignore-patterns=README*.md diff --git a/README.md b/README.md index 5bf8dfa..359dfe9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -
+
[![PyPI](https://img.shields.io/pypi/v/OpenAOE)](https://pypi.org/project/OpenAOE) diff --git a/docs/README_zh-CN.md b/docs/README_zh-CN.md index c7243a0..7e49b3a 100644 --- a/docs/README_zh-CN.md +++ b/docs/README_zh-CN.md @@ -1,4 +1,4 @@ -
+
[![PyPI](https://img.shields.io/pypi/v/OpenAOE)](https://pypi.org/project/OpenAOE)