Skip to content

Commit 3e66cd3

Browse files
committed
Update README with correct Kotlin version and app icon; fix GitHub Actions shell directive
- Update Kotlin version badge from 2.0 to 2.3.0 in README - Add app icon display to README header - Add shell: bash to GitHub Actions test step to fix gradlew permission issue
1 parent 2fd80bb commit 3e66cd3

2 files changed

Lines changed: 9 additions & 30 deletions

File tree

.github/workflows/build.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ jobs:
3030

3131
- name: Run tests
3232
run: ./gradlew :composeApp:test --no-daemon
33+
shell: bash
3334

3435
- name: Upload test results
3536
if: failure()

README.md

Lines changed: 8 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# KeyManager
22

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>
49

510
**Modern Desktop Application for Java Keystore Management**
611

712
[![Build Status](https://img.shields.io/github/actions/workflow/status/<username>/KeyManager/build.yml?branch=master)](https://github.com/<username>/KeyManager/actions)
813
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-blue)](https://github.com/<username>/KeyManager/releases)
914
[![Version](https://img.shields.io/badge/version-1.0.0-blue)](https://github.com/<username>/KeyManager/releases)
10-
[![Kotlin](https://img.shields.io/badge/Kotlin-2.0-purple)](https://kotlinlang.org)
15+
[![Kotlin](https://img.shields.io/badge/Kotlin-2.3.0-purple)](https://kotlinlang.org)
1116

1217
## Overview
1318

@@ -45,40 +50,13 @@ Download the installer for your architecture from the [Releases](https://github.
4550
- `keymanager-linux-x64.deb` (x86-64)
4651
- `keymanager-linux-arm64.deb` (ARM64)
4752

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-
7553
## Contributing
7654

7755
We welcome contributions! Whether you want to report bugs, suggest features, or submit code improvements:
7856

7957
1. **Report Issues**: Open a [GitHub Issue](https://github.com/<username>/KeyManager/issues) to report bugs or suggest features
8058
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
8260
4. **Testing**: Ensure all tests pass before submitting (`./gradlew :composeApp:test`)
8361

8462
Contributions are welcome! Feel free to open issues, submit pull requests, or suggest new features. Let's make KeyManager better together! 🚀

0 commit comments

Comments
 (0)