Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RayeRen committed Feb 22, 2022
1 parent a2e7591 commit 09028f1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Some examples:
1. Configure the google scholar citation crawler:
1. Find your google scholar ID in the url of your google scholar page (e.g., https://scholar.google.com/citations?user=SCHOLAR_ID), where `SCHOLAR_ID` is your google scholar ID.
1. Set GOOGLE_SCHOLAR_ID variable to your google scholar ID in `Settings -> Secrets -> Actions -> New repository secret` of the REPO website with `name=GOOGLE_SCHOLAR_ID` and `value=SCHOLAR_ID`.
1. Click the `Action` of the REPO website and enable the workflows by clicking *"I understand my workflows, go ahead and enable them"*. Star your REPO to trigger the `Get Citation Data` github action. This action will generate google scholar citation stats data `gs_data.json` in `google-scholar-stats` branch of your REPO. This action will be trigger 08:00 UTC everyday.
1. Click the `Action` of the REPO website and enable the workflows by clicking *"I understand my workflows, go ahead and enable them"*. This github action will generate google scholar citation stats data `gs_data.json` in `google-scholar-stats` branch of your REPO. When you update your main branch, this action will be triggered. This action will also be trigger 08:00 UTC everyday.
1. Generate favicon using [favicon-generator](https://redketchup.io/favicon-generator) and download all generated files to `REPO/images`.
1. Modify the configuration of your homepage `_config.yml`:
1. `title`: the title of your homepage
Expand All @@ -61,5 +61,5 @@ Some examples:
# Acknowledges

- AcadHomepage incorporates Font Awesome, which is distributed under the terms of the SIL OFL 1.1 and MIT License.
- AcadHomepage is influenced by the github repo (mmistakes/minimal-mistakes)[https://github.com/mmistakes/minimal-mistakes], which is distributed under the MIT License.
- AcadHomepage is influenced by the github repo (academicpages/academicpages.github.io)[https://github.com/academicpages/academicpages.github.io], which is distributed under the MIT License.
- AcadHomepage is influenced by the github repo [mmistakes/minimal-mistakes](https://github.com/mmistakes/minimal-mistakes), which is distributed under the MIT License.
- AcadHomepage is influenced by the github repo [academicpages/academicpages.github.io](https://github.com/academicpages/academicpages.github.io), which is distributed under the MIT License.
2 changes: 1 addition & 1 deletion docs/README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ AcadHomepage
1. 配置谷歌学术引用爬虫:
1. 在你的谷歌学术引用页面的url里找到你的谷歌学术ID:例如,在url https://scholar.google.com/citations?user=SCHOLAR_ID 中,`SCHOLAR_ID`部分即为你的谷歌学术ID。
1. 在github本仓库页面的`Settings -> Secrets -> Actions -> New repository secret`中,添加`GOOGLE_SCHOLAR_ID`变量:`name=GOOGLE_SCHOLAR_ID``value=SCHOLAR_ID`
1. 在github本仓库页面的`Action`中,点击*"I understand my workflows, go ahead and enable them"*启用workflows by clicking *"。Star你的REPO来触发`Get Citation Data` action。本action将会谷歌学术引用的统计量数据`gs_data.json`到本仓库的`google-scholar-stats`分支中。本action会在每天08:00 UTC触发
1. 在github本仓库页面的`Action`中,点击*"I understand my workflows, go ahead and enable them"*启用workflows by clicking *"。本action将会谷歌学术引用的统计量数据`gs_data.json`到本仓库的`google-scholar-stats`分支中。每次修改main分支的内容会触发该action。本action也会在每天08:00 UTC定时触发
1. 使用 [favicon-generator](https://redketchup.io/favicon-generator)生成favicon(网页icon文件),并下载所有文件到`REPO/images`
1. 修改主页配置文件[_config.yml](_config.yml):
1. `title`: 主页标题
Expand Down

0 comments on commit 09028f1

Please sign in to comment.