Skip to content

Commit 06c1f28

Browse files
author
realPaulsen
committed
updated README
1 parent 9ab40d3 commit 06c1f28

File tree

1 file changed

+39
-23
lines changed

1 file changed

+39
-23
lines changed

README.md

Lines changed: 39 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
11
# Java Project Library
22

33
![GitHub release (latest by date)](https://img.shields.io/github/v/release/realPaulsen/Java-Project-Library)
4-
![GitHub Release Date](https://img.shields.io/github/release-date/realPaulsen/Java-Project-Library?label=last%20RELEASE)
5-
![GitHub last commit](https://img.shields.io/github/last-commit/realPaulsen/Java-Project-Library?label=last%20COMMIT)
6-
4+
[![](https://jitpack.io/v/realPaulsen/java-project-library.svg)](https://jitpack.io/#realPaulsen/java-project-library)
75
![GitHub](https://img.shields.io/github/license/realPaulsen/Java-Project-Library)
8-
![Lines of code](https://img.shields.io/tokei/lines/github/realPaulsen/Java-Project-Library)
9-
10-
`Java-Project-Library` is a library for making small ***Coding-Projects*** of any kind really **fast**.
11-
12-
## Download
136

14-
<!-- TODO: Update D-Link after every new Release -->
7+
![GitHub Release Date](https://img.shields.io/github/release-date/realPaulsen/Java-Project-Library?label=last%20RELEASE)
8+
![GitHub last commit](https://img.shields.io/github/last-commit/realPaulsen/Java-Project-Library?label=last%20COMMIT)
159

16-
- [Versions](https://github.com/realPaulsen/Java-Project-Library/releases)
10+
The `Java-Project-Library` is a library for making small ***Coding-Projects*** of any kind really **fast**.
1711

18-
> **All Versions** are compiled with **Java 11**
1912

2013
## Introduction
2114

@@ -33,6 +26,7 @@
3326
- `PSystem`: Provides **System-Information** and functions (e.g. find out the OS-Type)
3427
- `PConsole`: Run a given Command in the Terminal/Console (Linux/Windows) and get the response
3528

29+
3630
## Why should I use this Library?
3731

3832
- ### Graphics:
@@ -57,21 +51,47 @@ You can also ***store basic attributes*** to files and later read them (similar
5751
simply `connect()` and `disConnect()` a device and attach a `PSerialListener` to read Data from the USB-Attached Device.
5852
Use `write(data)` to send data to the device.
5953

54+
**For more see my
55+
[included Demo](https://github.com/realPaulsen/Java-Project-Library/blob/main/src/com/paulsen/demo/Demo.java)**
56+
57+
6058
## Projects built with JPL:
6159
- [JAudioController](https://github.com/realPaulsen/AudioController)
6260
- [FileManager](https://github.com/realPaulsen/FileManager)
6361
- [ButtonBox V2](https://github.com/realPaulsen/ButtonBox_V2)
6462

65-
## How do I use it?
6663

67-
1. **Download** the [latest `.jar` file](#Download)
64+
## Usage
65+
This library can be loaded using [JitPack](https://jitpack.io/#realPaulsen/java-project-library)
66+
```xml
67+
<repositories>
68+
<repository>
69+
<id>jitpack.io</id>
70+
<url>https://jitpack.io</url>
71+
</repository>
72+
</repositories>
73+
```
74+
75+
Include the dependency (change version *[version](https://github.com/realPaulsen/Java-Project-Library/releases)* if needed)
76+
77+
```xml
78+
<dependencies>
79+
<dependency>
80+
<groupId>com.github.realPaulsen</groupId>
81+
<artifactId>java-project-library</artifactId>
82+
<version>[1.1.6,1.1.7)</version>
83+
</dependency>
84+
</dependencies>
85+
```
86+
87+
### Alternatively using jar
88+
89+
1. **Download / Build** the latest Version
6890
2. **Include** the library into your project
6991
- ***IntelliJ:*** `File > Project Structure > Libraries > +`
7092
- ***Eclipse:*** `Right-Click Project > Properties > Java Build Path > Add External JARs`
7193
3. **Start** with your project
7294

73-
**For more see my
74-
[included Demo](https://github.com/realPaulsen/Java-Project-Library/blob/main/src/com/paulsen/demo/Demo.java)**
7595

7696
## Troubleshooting
7797

@@ -82,6 +102,7 @@ Use `write(data)` to send data to the device.
82102
* **Still** got **problems** or have issues adding yourself to the Groups:<br>
83103
Look up the **jSerialComm-[Troubleshooting-Wiki](https://github.com/Fazecast/jSerialComm/wiki/Troubleshooting)**
84104

105+
85106
## Credit & Status
86107

87108
The Library [jSerialComm](https://github.com/Fazecast/jSerialComm) is used for USB/Serial communication.
@@ -92,19 +113,14 @@ by [`Paulsen`](https://github.com/realPaulsen)
92113
### TODOs & In-Progress
93114

94115
- **BugFixes**
95-
- ...
116+
- Resizing Window to Fullscreen does not always draw/update to latest size
96117
- **Changes**
118+
- Optimize draw call by only redrawing region of parent that intersects with the updated Element
119+
- Use JSON as DataStorage
97120
- Base `PUIElement` directly form JComponent and restructure PUICore/PUIFrame
98121
- **FixPoints** on PUISlider
99122
- **Free** movable PUIElements on PUIScrollPanel (without snapped locations)
100123
- **Additions**
101124
- **Graph plotter**: Plot multiple graphs and analyze them
102125
- **Built-In File-Browser** based on PUIList
103126
- **Comments**/JavaDoc still missing😬
104-
105-
106-
107-
## Build-Notes
108-
109-
* Import the latest Build of external library [jSerialComm](https://github.com/Fazecast/jSerialComm) for serial/USB-Connection
110-

0 commit comments

Comments
 (0)