Skip to content

Commit 5781e59

Browse files
committed
Update Readme.md & workflows
1 parent 9565adc commit 5781e59

File tree

5 files changed

+10
-42
lines changed

5 files changed

+10
-42
lines changed

.github/workflows/main-branch.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ on:
99
- 'CONTRIBUTING.md'
1010
- 'LICENSE'
1111
- '.github/**'
12+
- 'examples/**'
1213
workflow_dispatch:
1314

1415
jobs:

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ LPFCP Java implements the LPFCP protocol — check out the [LPFCP protocol speci
4747
- 🔌 **Java & Kotlin Support** – Use LPFCP from either language with the same ease.
4848
- 🛠 **Zero-Boilerplate** – No manual serialization or wiring; LPFCP takes care of it using reflection.
4949

50+
### Read our [Wiki](https://likespro.gitbook.io/lpfcp-java)
51+
5052
---
5153

5254
## Getting Started

examples/calculator-java/.idea/gradle.xml

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/calculator-java/README.md

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,5 @@
1-
# calculator
1+
# Calculator
22

3-
This project uses [Gradle](https://gradle.org/).
4-
To build and run the application, use the *Gradle* tool window by clicking the Gradle icon in the right-hand toolbar,
5-
or run it directly from the terminal:
3+
A calculator application server & client side implementation with LPFCP Java using **Java**.
64

7-
* Run `./gradlew run` to build and run the application.
8-
* Run `./gradlew build` to only build the application.
9-
* Run `./gradlew check` to run all checks, including tests.
10-
* Run `./gradlew clean` to clean all build outputs.
11-
12-
Note the usage of the Gradle Wrapper (`./gradlew`).
13-
This is the suggested way to use Gradle in production projects.
14-
15-
[Learn more about the Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html).
16-
17-
[Learn more about Gradle tasks](https://docs.gradle.org/current/userguide/command_line_interface.html#common_tasks).
18-
19-
This project follows the suggested multi-module setup and consists of the `app` and `utils` subprojects.
20-
The shared build logic was extracted to a convention plugin located in `buildSrc`.
21-
22-
This project uses a version catalog (see `gradle/libs.versions.toml`) to declare and version dependencies
23-
and both a build cache and a configuration cache (see `gradle.properties`).
5+
To build all jars execute `./gradlew build`. Jars will be in `build/libs` folder
Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,5 @@
1-
# calculator
1+
# Calculator
22

3-
This project uses [Gradle](https://gradle.org/).
4-
To build and run the application, use the *Gradle* tool window by clicking the Gradle icon in the right-hand toolbar,
5-
or run it directly from the terminal:
3+
A calculator application server & client side implementation with LPFCP Java using **Kotlin**.
64

7-
* Run `./gradlew run` to build and run the application.
8-
* Run `./gradlew build` to only build the application.
9-
* Run `./gradlew check` to run all checks, including tests.
10-
* Run `./gradlew clean` to clean all build outputs.
11-
12-
Note the usage of the Gradle Wrapper (`./gradlew`).
13-
This is the suggested way to use Gradle in production projects.
14-
15-
[Learn more about the Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html).
16-
17-
[Learn more about Gradle tasks](https://docs.gradle.org/current/userguide/command_line_interface.html#common_tasks).
18-
19-
This project follows the suggested multi-module setup and consists of the `app` and `utils` subprojects.
20-
The shared build logic was extracted to a convention plugin located in `buildSrc`.
21-
22-
This project uses a version catalog (see `gradle/libs.versions.toml`) to declare and version dependencies
23-
and both a build cache and a configuration cache (see `gradle.properties`).
5+
To build all jars execute `./gradlew build`. Jars will be in `build/libs` folder

0 commit comments

Comments
 (0)