https://github.com/lzw-723/kuengi

https://github.com/lzw-723/kuengi

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/lzw-723/kuengi
• Owner: lzw-723
• License: lgpl-3.0
• Created: 2023-07-22T05:28:43.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-27T15:49:15.000Z (11 months ago)
• Last Synced: 2024-10-12T19:44:10.834Z (about 1 month ago)
• Language: Java
• Size: 57.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kuengi

欢迎参与本项目的开发！

## 项目概述

Kuengi是一个基于JavaFX的EPUB阅读器，用于阅读和浏览EPUB格式的电子书。

该项目旨在提供一个简单、实用且易于扩展的阅读工具，以满足用户对阅读EPUB电子书的舒适需求。

## 功能特性

* [ ] 支持EPUB格式的电子书阅读和浏览。

* [ ] 高清晰度显示，呈现精美的排版和图像。

* [ ] 支持翻页和滚动浏览。

* [ ] 支持字体大小调整和颜色设置。

* [ ] 支持书签功能，方便快速定位特定章节或页面。

* [ ] 支持搜索功能，快速查找特定内容。

* [ ] 提供简单的文件管理和编辑功能。

## 开发环境

* JDK 11 或更高版本

* Maven 构建工具

## 项目结构

src/main/java：Java源代码目录。

src/main/resources：资源文件目录，包括样式表、图像和配置文件等。

pom.xml：Maven构建配置文件

## 编译与构建

* Maven构建

在项目根目录下打开终端或命令提示符。

运行`mvn clean package`命令进行编译和构建。

生成的可执行JAR文件将位于target目录下。

## 运行

在项目根目录下打开终端或命令提示符。

使用以下命令运行应用程序：java -jar <可执行JAR文件名>。

使用Maven构建工具，可执行JAR文件名为target/kuengi-<版本号>-jar-with-dependencies.jar。

等待应用程序启动，然后可以享受阅读和浏览EPUB电子书的功能了！

### 调试与测试

TODO

确保在开发和测试过程中遵循良好的编程实践和规范，以确保代码的质量和可维护性。

## 贡献与社区支持

我们欢迎任何形式的贡献和支持！

如果您发现任何错误、问题或需要改进的地方，请随时提交问题或拉取请求（Pull Request）。

我们将尽快审查和处理您的贡献，并与您进行进一步的讨论和合作。

同时，我们也鼓励您参与社区讨论和分享您的经验、想法和建议，以促进项目的发展和进步。

## 开源许可证

LGPL-v3