From 111c6ad3e0832ecd9171e341f6724dbe239fae08 Mon Sep 17 00:00:00 2001 From: xTaiwanPingLord Date: Thu, 8 Sep 2022 22:44:09 +0800 Subject: [PATCH] Edit README because I moved the building procedures to wiki --- README.md | 46 ++++++++-------------------------------- README_zh-Hans.md | 46 ++++++++-------------------------------- README_zh-Hant.md | 53 +++++++++++------------------------------------ 3 files changed, 30 insertions(+), 115 deletions(-) diff --git a/README.md b/README.md index 79afacd..59f550d 100644 --- a/README.md +++ b/README.md @@ -16,14 +16,6 @@

Getting Started

-## Building from source -It is recommended to use [Visual Studio 2022.](https://visualstudio.microsoft.com/) -As well as setting up **`cheat-library`** as startup project. -**The following is a recommended procedure, but others may be used.** -1. Clone repository with `git clone --recurse-submodules https://github.com/Akebi-Group/Akebi-GC.git` -1. Open `Akebi-GC/akebi-gc.sln` -1. Build solution `akebi-gc.sln`. - ## Stable Release 1. Head over to the releases page 1. Download the latest binaries @@ -40,24 +32,16 @@ As well as setting up **`cheat-library`** as startup project.

- -### Requirements -- [Visual C++ Redistributable packages for Visual Studio 2015-2022](https://aka.ms/vs/17/release/vc_redist.x64.exe) (x64) -- [Visual C++ Redistributable packages for Visual Studio 2015-2022](https://aka.ms/vs/17/release/vc_redist.x86.exe) (x86) +## Building from source +Check our wiki - [Building](https://github.com/Akebi-Group/Akebi-GC/wiki/Building%EF%BD%9C%E5%BB%BA%E7%BD%AE) ### Usage -(1-2 are optional if you didn't build from source) -1. Open `/bin` -1. Open Compiled version (debug, release) - - 1. Ensure that `CLibrary.dll` is in the same folder that `injector.exe`. -1. Run `injector.exe`. -1. After the login page appeared, press F1 to open Akebi GUI. +2. Run `injector.exe`. +3. After the login page appeared, press F1 to open Akebi GUI.

Features

- #### General - Protection Bypass - In-Game GUI @@ -117,7 +101,6 @@ As well as setting up **`cheat-library`** as startup project. - FPS Graph - [Packet Sniffer](https://github.com/Akebi-Group/Akebi-PacketSniffer) -

Demo

@@ -146,37 +129,26 @@ As well as setting up **`cheat-library`** as startup project.

Bugs

+ Welcome to the short explanation for bug reporting 1. You found a bug. 1. Write down what happened, as well as your first thoughts on what you think caused it. 1. Can it be reproduced? Yes or no. If yes: Explain in as much clear as possible. i.e what happens when the bug occurs and why it occurs. 1. Tell us which version you are using. copy the `SHA`/ Version Number of the latest commit when you built the mod. For example: `bd17a00ec388f3b93624280cde9e1c66e740edf9` / Release 0.7 - -## Bug reporting template -
- -### Ex. -I found a bug in the feature `enemy vacuum`. -I think it's caused by the filter functions that are defined in `someFeature.cpp`. - -``` -Date Occured: 5/3/2022 -Is it reproducible: Occasionally -Latest Commit used: bd17a00ec388f3b93624280cde9e1c66e740edf9 -Release Version: 0.7 -``` +1. [Open an Issue(there's a template!)](https://github.com/Akebi-Group/Akebi-GC/issues)

Contributing

+ ## Adding a feature 1. Fork the Project 1. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 1. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 1. Push to the Branch (`git push origin feature/AmazingFeature`) -1. Open a Pull Request +1. (Open a Pull Request)[https://github.com/Akebi-Group/Akebi-GC/pulls] ## Suggestions Open an issue with the title of the suggestion you want to make. -In the description, make sure it is descriptive enough so our devs can understand what you want and how you want it. +In the description, make sure it is descriptive enough so our devs can understand what you want and how you want it. \ No newline at end of file diff --git a/README_zh-Hans.md b/README_zh-Hans.md index c2f936d..b488b35 100644 --- a/README_zh-Hans.md +++ b/README_zh-Hans.md @@ -16,14 +16,6 @@

入门教程

-## 编译 -推荐使用 [Visual Studio 2022.](https://visualstudio.microsoft.com/)，同时以**`cheat-library`**作为启动项目。 -**下面是一种推荐编译方式，当然也可以使用其他任何你喜欢的方式** - -1. 使用 `git clone --recurse-submodules https://github.com/Akebi-Group/Akebi-GC.git` 命令来下载本仓库 -1. 打开 `Akebi-GC/akebi-gc.sln` -1. 编译解决方案(默认Ctrl+Shift+B) `akebi-gc.sln`。 - ## 稳定版本 1. 前往[Releases](https://github.com/Akebi-Group/Akebi-GC/releases)頁面 1. 下载最新的版本 @@ -40,22 +32,16 @@

- -### 需要依赖 -- [Visual C++ Redistributable packages for Visual Studio 2015-2022](https://aka.ms/vs/17/release/vc_redist.x64.exe) (x64) -- [Visual C++ Redistributable packages for Visual Studio 2015-2022](https://aka.ms/vs/17/release/vc_redist.x86.exe) (x86) +## 自行编译 +请查看wiki - [Building](https://github.com/Akebi-Group/Akebi-GC/wiki/Building%EF%BD%9C%E5%BB%BA%E7%BD%AE) ### 使用方法 -（如果不是从源码自己构建的话，无视步骤`1`跟`2`。） -1. 打开 `/bin` -1. 打开已经编译好的版本文件夹(debug, release) 1. 确认 `CLibrary.dll` 跟 `injector.exe` 处在同一个文件夹内。 -1. 运行 `injector.exe`. -1. 等到登录界面出现，按`F1`键打开`Akebi GUI`。 +2. 运行 `injector.exe`. +3. 等到登录界面出现，按`F1`键打开`Akebi GUI`。

功能简介

- #### 通用 - 过检测 - 游戏内界面 @@ -115,7 +101,6 @@ - FPS曲线图 - [抓包工具](https://github.com/Akebi-Group/Akebi-PacketSniffer) -

功能演示

@@ -143,28 +128,15 @@
-

Bugs

-欢迎阅读如何提交`BUG`报告 + +欢迎阅读如何提交`BUG`报告(开启issue时，有提供模板) 1. 发现了一个`bug`。 1. 记下问题出现时发生了什么，以及你认为这是由于什么造成的。 1. 可以复现吗？可以或不可以。如果可以：尽可能的描述清楚问题发生时，发生了什么，开启了什么功能以及最可能的原因是什么。 ~~如果不可以：**就别报告了，建议重启**。~~ 1. 告诉我们你使用的是哪一个版本。复制你编译的最新的提交的`SHA`或者版本号。例如：`bd17a00ec388f3b93624280cde9e1c66e740edf9` / Release 0.7 - -## **错误报告模板** - - -### 模板（最好使用英文） -I found a bug in the feature `enemy vacuum`. -I think it's caused by the filter functions that are defined in `someFeature.cpp`. - -``` -Date Occured: 5/3/2022 -Is it reproducible: Occasionally -Latest Commit used: bd17a00ec388f3b93624280cde9e1c66e740edf9 -Release Version: 0.7 -``` +1. [打开一个Issue(有提供模板!)](https://github.com/Akebi-Group/Akebi-GC/issues)

提交贡献

@@ -173,8 +145,8 @@ Release Version: 0.7 1. 创建一个新的功能分支（`git checkout -b feature/AmazingFeature`） 1. 提交更改（`git commit -m 'Add some AmazingFeature'`） 1. 推送（Push）更改到分支（`git push origin feature/AmazingFeature`） -1. 打开 Pull Request 并提交 +1. (打开 Pull Request 并提交)[https://github.com/Akebi-Group/Akebi-GC/pulls] ## 建议 -新建一个Issue，标题写上你的建议，并且在描述里面，清晰的写下你的建议描述，以便我们的开发人员可以理解你的建议 +新建一个Issue，标题写上你的建议，并且在描述里面，清晰的写下你的建议描述，以便我们的开发人员可以理解你的建议 \ No newline at end of file diff --git a/README_zh-Hant.md b/README_zh-Hant.md index 83e2316..1d40419 100644 --- a/README_zh-Hant.md +++ b/README_zh-Hant.md @@ -16,14 +16,6 @@

入門指南

-## 編譯 -建議使用 [Visual Studio 2022.](https://visualstudio.microsoft.com/) -以及建立**`cheat-library`**作為啟動專案。 -**以下是一個推薦的編譯方式，但也可以使用其他辦法。** -1. 利用 `git clone --recurse-submodules https://github.com/Akebi-Group/Akebi-GC.git` 來下載存儲庫 -1. 開啟 `Akebi-GC/akebi-gc.sln` -1. 編譯解決方案 `akebi-gc.sln`。 - ## 穩定版本 1. 前往[Releases](https://github.com/Akebi-Group/Akebi-GC/releases)頁面 1. 下載最新的版本 @@ -40,24 +32,16 @@

- -### 依賴 -- [適用於Visual Studio 的Visual C++ 可轉散發套件2015-2022](https://aka.ms/vs/17/release/vc_redist.x64.exe) (x64) -- [適用於Visual Studio 的Visual C++ 可轉散發套件2015-2022](https://aka.ms/vs/17/release/vc_redist.x86.exe) (x86) +## 自行編譯 +請查看wiki - [Building](https://github.com/Akebi-Group/Akebi-GC/wiki/Building%EF%BD%9C%E5%BB%BA%E7%BD%AE) ### 使用方法 -（如果你不是從原始碼構建的話，您可以跳過步驟1-2。） -1. 開啟 `/bin` -1. 開啟已編譯版本(debug, release) - - 1. 確保 `CLibrary.dll` 跟 `injector.exe` 在同一個資料夾裡面。 -1. 執行 `injector.exe`. -1. 等到登錄界面出現後，按下F1來打開Akebi介面。 +2. 執行 `injector.exe`. +3. 等到登錄界面出現後，按下F1來打開Akebi介面。

功能簡介

- #### 一般 - 繞過防作弊機制 - 遊戲內介面 @@ -117,7 +101,6 @@ - FPS曲線圖 - [抓包工具](https://github.com/Akebi-Group/Akebi-PacketSniffer) -

功能演示

@@ -146,37 +129,25 @@

Bugs

-歡迎閱讀關於錯誤報告（Bug reporting）的簡短解釋！ + +歡迎閱讀關於錯誤報告（Bug reporting）的簡短解釋！(開啟issue時，有提供模板) 1. 您發現了一個錯誤。 1. 把接下來發生的事情記錄下來，以及你認為造成這種情況的第一想法。 -1. 它可以被重現嗎？可以或不可以。如果可以：盡可能清楚地解釋清楚，當錯誤發生時，會發生什麼，為什麼會發生。 ~~如果不可以：無須報告，建議求佛。~~ +1. 它可以被重現嗎？可以或不可以。如果可以：盡可能清楚地解釋清楚，當錯誤發生時，會發生什麼，為什麼會發生。 ~~如果不可以：無須報告，建議求佛。我們不會通靈。~~ 1. 告訴我們你使用的是哪個版本。複製你建立mod時的最新提交的SHA Hash/版本號。例如：`bd17a00ec388f3b93624280cde9e1c66e740edf9` / Release 0.7 - -## 錯誤報告範本 -
- -### 範例（建議使用英文） -I found a bug in the feature `enemy vacuum`. -I think it's caused by the filter functions that are defined in `someFeature.cpp`. - -``` -Date Occured: 5/3/2022 -Is it reproducible: Occasionally -Latest Commit used: bd17a00ec388f3b93624280cde9e1c66e740edf9 -Release Version: 0.7 -``` +1. [開啟一個Issue(有提供模板!)](https://github.com/Akebi-Group/Akebi-GC/issues)

社群貢獻

## 增加一個功能 -1. 建立新的分支 +1. 建立新的分支(Fork) 1. 創建你的功能分支（`git checkout -b feature/AmazingFeature`） 1. 提交您的更改（`git commit -m 'Add some AmazingFeature'`） 1. 上傳（Push）到分支（`git push origin feature/AmazingFeature`） -1. 開啟一個 Pull Request +1. (開啟一個 Pull Request)[https://github.com/Akebi-Group/Akebi-GC/pulls] ## 建議 -用你想提出的建議的東西開一個問題（Issues）。 -在描述中，確保它有足夠的描述性，以便我們的開發人員能夠理解你想要什麼以及你想要怎樣。 +用你想提出的建議，開一個問題（Issues）。 +在描述中，確保內容有足夠的描述性，以便我們的開發人員能夠理解，你想要什麼以及你想要怎樣。 \ No newline at end of file