Skip to content

Commit

Permalink
update README, version 1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Syize committed Oct 4, 2023
1 parent f3af91e commit 8d49e02
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ build/
*.user
.cache/
dist/
package/
36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# coursework-a-table-pet-Haro

使用C++与Qt写的一个桌面宠物,命名为Haro(neta高达),[B站传送门](https://www.bilibili.com/video/BV1Zv4y117Xt)

Haro (Gun-neta), A desktop pet written with C++ and Qt. [Video](https://www.bilibili.com/video/BV1Zv4y117Xt)

[简体中文](README_CN.md)

## Build

## Prerequisites
### Prerequisites

Haro uses `QMediaPlaylist` which has been removed in `Qt 6.X` to display music list, so you need to intall `Qt 5.X` to build Haro.

Expand All @@ -21,3 +21,33 @@ You can open this project with `VS Code`or `Qt Creator`.
Clone this repo, open your `Qt Creator` and `Open Project...` with `CMakeLists.txt`, then you can build Haro in `Qt Creator`.

Clone this repo, open the folder with your `VS Code`, right click `CMakeLists.txt` and select `Clean Reconfigure All Projects` and `Clean Rebuild All Projects`, done!

## Installation

### Windows

Download the latest installer from [release](https://github.com/Syize/coursework-a-table-pet-Haro/releases), and run.

**NOTE: On Windows, Qt's QSettings class uses the Windows registry to store some settings. Currently, Haro does not have code to completely remove these settings during uninstallation. So, if you wish to uninstall Haro, you may need to manually clear these settings. However, rest assured that Haro does not store any user tracking information in the registry; it only contains some configuration settings. For example:**

> Content of settings file on Linux
```ini
[General]
AutoStart=false
Body=6
Ear=4
WindowSize=400

[Coordinates]
X=1004
Y=176

[Game]
File="Executable File Path"
Hide=true
```

### Linux

Still learning how to package....
51 changes: 51 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# coursework-a-table-pet-Haro

使用C++与Qt写的一个桌面宠物,命名为Haro(neta高达),[B站传送门](https://www.bilibili.com/video/BV1Zv4y117Xt)

## 构建

### 注意

Haro使用`QMediaPlaylist`来显示音乐列表,但是在`Qt 6.X`版本中该类已经被移除,所以Haro只兼容`Qt 5.X`

### 使用qmake构建

克隆本仓库,在`Qt Creator`中打开项目,选择`Haro.pro`文件。

### 使用CMake构建

你可以使用`VS Code`或者`Qt Creator`构建。

克隆本仓库,在`Qt Creator`中打开项目,选择`CMakeLists.txt`文件。

克隆本仓库,在`VS Code`中打开项目,选择`CMakeLists.txt`文件。

## 安装

### Windows

从最新的[release](https://github.com/Syize/coursework-a-table-pet-Haro/releases)中下载安装包并运行。

**注意:在Windows上,"Qt的QSettings类会使用Windows的注册表来存储一些设置,目前Haro没有编写在卸载时完全清除这些设置的代码,因此如果你想要卸载Haro的话,有可能需要手动清除这些设置。但是不用担心,Haro不会在注册表里面存储跟踪用户的信息,仅仅是一些设置信息。例如**

> 以下是Linux平台记录的设置项,与Windows上的条目相同
```ini
[General]
AutoStart=false
Body=6
Ear=4
WindowSize=400

[Coordinates]
X=1004
Y=176

[Game]
File="Executable File Path"
Hide=true
```

### Linux

还在学习打包中...

0 comments on commit 8d49e02

Please sign in to comment.