|
1 | 1 | # KeyManager |
2 | 2 |
|
3 | | -<!-- Add app icon here --> |
| 3 | +<div align="center"> |
| 4 | + <picture> |
| 5 | + <source media="(prefers-color-scheme: dark)" srcset="composeApp/src/jvmMain/composeResources/drawable/app_icon.xml"> |
| 6 | + <img alt="KeyManager Icon" src="composeApp/src/jvmMain/composeResources/drawable/app_icon.xml" width="120"> |
| 7 | + </picture> |
| 8 | +</div> |
4 | 9 |
|
5 | 10 | **Modern Desktop Application for Java Keystore Management** |
6 | 11 |
|
7 | 12 | [](https://github.com/<username>/KeyManager/actions) |
8 | 13 | [](https://github.com/<username>/KeyManager/releases) |
9 | 14 | [](https://github.com/<username>/KeyManager/releases) |
10 | | -[](https://kotlinlang.org) |
| 15 | +[](https://kotlinlang.org) |
11 | 16 |
|
12 | 17 | ## Overview |
13 | 18 |
|
@@ -45,40 +50,13 @@ Download the installer for your architecture from the [Releases](https://github. |
45 | 50 | - `keymanager-linux-x64.deb` (x86-64) |
46 | 51 | - `keymanager-linux-arm64.deb` (ARM64) |
47 | 52 |
|
48 | | -### System Requirements |
49 | | - |
50 | | -- **Java 21 or later** (JRE required to run the application) |
51 | | -- **Memory**: 512 MB minimum, 2 GB recommended |
52 | | -- **Disk Space**: 200 MB for installation |
53 | | - |
54 | | -## Building from Source |
55 | | - |
56 | | -### Prerequisites |
57 | | -- JDK 21 or later |
58 | | -- Git |
59 | | - |
60 | | -### Build Commands |
61 | | - |
62 | | -```bash |
63 | | -# Run the application |
64 | | -./gradlew :composeApp:run |
65 | | - |
66 | | -# Run all tests |
67 | | -./gradlew :composeApp:test |
68 | | - |
69 | | -# Build distribution packages |
70 | | -./gradlew :composeApp:packageDmg # macOS DMG |
71 | | -./gradlew :composeApp:packageMsi # Windows MSI |
72 | | -./gradlew :composeApp:packageDeb # Linux DEB |
73 | | -``` |
74 | | - |
75 | 53 | ## Contributing |
76 | 54 |
|
77 | 55 | We welcome contributions! Whether you want to report bugs, suggest features, or submit code improvements: |
78 | 56 |
|
79 | 57 | 1. **Report Issues**: Open a [GitHub Issue](https://github.com/<username>/KeyManager/issues) to report bugs or suggest features |
80 | 58 | 2. **Submit Pull Requests**: Fork the repository, create a feature branch, and submit a PR with your improvements |
81 | | -3. **Code Guidelines**: Follow the existing code style and patterns (see [Architecture](./claude/docs/architecture.md)) |
| 59 | +3. **Code Guidelines**: Follow the existing code style and patterns |
82 | 60 | 4. **Testing**: Ensure all tests pass before submitting (`./gradlew :composeApp:test`) |
83 | 61 |
|
84 | 62 | Contributions are welcome! Feel free to open issues, submit pull requests, or suggest new features. Let's make KeyManager better together! 🚀 |
|
0 commit comments