forked from download-online-video/chrome-avgle-helper
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
51 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,5 @@ | ||
# CONTRIBUTING | ||
|
||
## Chrome extension | ||
Latest contributing document has been moved to [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) | ||
|
||
``` bash | ||
# Install Node.js | ||
# Visit: https://nodejs.org/en/ | ||
|
||
# Install dependencies | ||
npm install | ||
|
||
# Start builder | ||
npm run dev | ||
``` | ||
最新的开发说明文档已经被移动到了 [docs/CONTRIBUTING.zh-Hans.md](docs/CONTRIBUTING.zh-Hans.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# CONTRIBUTING | ||
|
||
## 0x00. Project struct | ||
|
||
- **build**: Node.js scripts for building the Chrome extension from source codes located in directory **src** | ||
- **docs**: Documents about this project | ||
- **extension**: The struct of a complete Chrome extension | ||
- **dist**: Codes built from **src** | ||
- **icons**: Icon files for this Chrome extension | ||
- **src**: This extension source code | ||
- **test**: Some scripts for testing | ||
|
||
## 0x01. How to build this Chrome extension | ||
|
||
``` bash | ||
# Install Node.js | ||
# Visit: https://nodejs.org/en/ | ||
|
||
# Install dependencies | ||
yarn install | ||
|
||
# Launch builder script | ||
yarn run dev | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# CONTRIBUTING | ||
|
||
## 0x00. 项目结构 | ||
|
||
- **build**: Node.js 脚本, 用来从 **src** 目录中构建 Chrome 插件的源代码 | ||
- **docs**: 项目文档 | ||
- **extension**: 完整的 Chrome 插件的目录结构 | ||
- **dist**: 从 **src** 目录构建出来的代码 | ||
- **icons**: Chrome 插件需要用到的图标文件 | ||
- **src**: 这个 Chrome 插件的源代码 | ||
- **test**: 用来测试的代码 | ||
|
||
|
||
## 0x01. 如何构建这个 Chrome 插件 | ||
|
||
``` bash | ||
# 安装 Node.js | ||
# 请访问: https://nodejs.org/en/ | ||
|
||
# 安装项目依赖 | ||
yarn install | ||
|
||
# 启动构建脚本 | ||
yarn run dev | ||
``` |