Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jiangxincode committed May 19, 2024
1 parent e3e3502 commit 9492dc5
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 18 deletions.
26 changes: 11 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,27 +28,23 @@ ApkToolBoxGUI是一个方便程序员使用的工具,具有用户友好的图

[![Documentation](https://img.shields.io/badge/Documentation-文档-green.svg)](https://jiangxincode.github.io/ApkToolBoxGUI)

* [Password Recovery(密码恢复)](./src/site/markdown/features/recovery_file_password.md)
* [Batch Rename(批量重命名)](./src/site/markdown/features/batch_rename.md)
* [Check Summary(文件摘要检查)](./src/site/markdown/features/check_summary.md)
* [Color Picker(颜色拾取器)](./src/site/markdown/features/color_picker.md)
* [Base Convert(进制转换)](./src/site/markdown/features/convert_base.md)
* [OS Pattern Convert(操作系统文件格式转换)](./src/site/markdown/features/convert_os_pattern.md)
* [Time Convert(时间格式转换)](./src/site/markdown/features/convert_time_format.md)
* [Decode Protobuf(Protobuf解码)](./src/site/markdown/features/decode_protobuf.md)
* [Find Duplicate Files(重复文件查找)](./src/site/markdown/features/find_duplicate_files.md)
* [Reverse Engineer(逆向工程)](./src/site/markdown/features/reverse_engineer.md)
* [Android Develop(Android开发)](./src/site/markdown/features/android_i18n_operation.md)
* [Password Recovery(密码恢复)](https://jiangxincode.github.io/ApkToolBoxGUI/features/recovery_file_password.html)
* [Batch Rename(批量重命名)](https://jiangxincode.github.io/ApkToolBoxGUI/features/batch_rename.html)
* [Check Summary(文件摘要检查)](https://jiangxincode.github.io/ApkToolBoxGUI/features/check_summary.html)
* [Color Picker(颜色拾取器)](https://jiangxincode.github.io/ApkToolBoxGUI/features/color_picker.html)
* [Base Convert(进制转换)](https://jiangxincode.github.io/ApkToolBoxGUI/features/convert_base.html)
* [OS Pattern Convert(操作系统文件格式转换)](https://jiangxincode.github.io/ApkToolBoxGUI/features/convert_os_pattern.html)
* [Time Convert(时间格式转换)](https://jiangxincode.github.io/ApkToolBoxGUI/features/convert_time_format.html)
* [Decode Protobuf(Protobuf解码)](https://jiangxincode.github.io/ApkToolBoxGUI/features/decode_protobuf.html)
* [Find Duplicate Files(重复文件查找)](https://jiangxincode.github.io/ApkToolBoxGUI/features/find_duplicate_files.html)
* [Reverse Engineer(逆向工程)](https://jiangxincode.github.io/ApkToolBoxGUI/features/reverse_engineer.html)
* [Android Develop(Android开发)](https://jiangxincode.github.io/ApkToolBoxGUI/features/android_i18n_operation.html)
* ...

## Contribute(共同参与)

[![Documentation](https://img.shields.io/badge/Contribute-共同参与-green.svg)](https://jiangxincode.github.io/ApkToolBoxGUI/contribute/how_to_contribute.html)

## Contributors(贡献者)

* Jiangxin <jiangxinnju@gmail.com>

## Communication Group(交流群)

![QQ Group](https://raw.githubusercontent.com/wiki/jiangxincode/ApkToolBoxGUI/QQ_Group.png)
20 changes: 17 additions & 3 deletions src/site/markdown/contribute/how_to_contribute.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
## How To Contribute

Feel free to dive in! [Open an issue](https://github.com/jiangxincode/ApkToolBoxGUI/issues/new) or submit PRs.
* Report a bug or request a new feature by [Open an issue](https://github.com/jiangxincode/ApkToolBoxGUI/issues/new)
* Submit Pull Request if you are interested in development with us:
* Fix some bugs
* Add some new features
* Improve the documents
* Refactor the code
* Fix some bad code smell reported by various CI tools
* Optimize the performance
* Add some tests
* Add some translations
* Help us to broadcast this project and let more people know it

Standard Readme follows the [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/) Code of Conduct.
Feel free to dive in! You can do everything to help this project. All you need to do is to follow the [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/).

### How to build
### How to build the project

* Build binary: `mvn clean package`
* Build zip: `./PackageWindows.ps1` on Windows platform or `./PackageLinuxOrMacos.sh` on others
* Build document: `mvn clean site`

### Contributors

* Jiangxin <jiangxinnju@gmail.com>

0 comments on commit 9492dc5

Please sign in to comment.