Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
CharlesPikachu committed Jan 8, 2022
1 parent 09b1d8b commit 884be2e
Show file tree
Hide file tree
Showing 10 changed files with 563 additions and 169 deletions.
15 changes: 15 additions & 0 deletions docs/Author.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# 关于作者

```
学生党, 主要研究方向是计算机视觉, 顺便对信息安全感兴趣。
我的个人微信公众号是: Charles_pikachu (欢迎搜索关注,或者搜"Charles的皮卡丘")
我的Github账号是: https://github.com/CharlesPikachu
我的知乎账号是: https://www.zhihu.com/people/charles_pikachu
我的B站账号是: https://space.bilibili.com/406756145
个人邮箱: [email protected]
```
3 changes: 3 additions & 0 deletions docs/Changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# 开发日志

- 2022-01-08: 完成v0.1.0, 集成了27款小游戏
44 changes: 44 additions & 0 deletions docs/Install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# 安装CPGames


## 环境配置
- 操作系统: Linux or macOS or Windows
- Python版本: Python3.6+


## Whl文件安装(推荐)
在终端运行如下命令即可(请保证python在环境变量中):
```sh
wget https://github.com/CharlesPikachu/Games/releases/download/v0.1.0/cpgames-0.1.0-py3-none-any.whl
pip install cpgames-0.1.0-py3-none-any.whl
```


## PIP安装(推荐)
在终端运行如下命令即可(请保证python在环境变量中):
```sh
pip install cpgames --upgrade
```


## 源代码安装

#### 在线安装
运行如下命令即可在线安装:
```sh
pip install git+https://github.com/CharlesPikachu/Games.git@master
```

#### 离线安装
利用如下命令下载Games源代码到本地:
```sh
git clone https://github.com/CharlesPikachu/Games.git
```
接着, 切到Games目录下:
```sh
cd Games
```
最后运行如下命令进行安装:
```sh
python setup.py install
```
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Loading

0 comments on commit 884be2e

Please sign in to comment.