Readme work

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>
This commit is contained in:
2024-09-30 22:34:38 +02:00
parent a34b6ae552
commit 458e154168

View File

@@ -25,6 +25,10 @@ Das Ermöglicht es, dass die compilierte JAR-Datei weniger als 1,5 MB groß ist!
Dies ist ein Gradle-Project. Um es zu compilieren brauchen Sie ein aktuelles Java-Development-Kit.
Das Projekt kann durch Aufruf von `./gradlew build` in einem Terminal innerhalb des Wurzelverzeichnisses gebaut werden.
## Datenbank-Unterstützung
Um das Projekt klein zu halten ist im _main_-Branch kein Datenbank-Support eingebaut.
Es gibt aber einen separaten Branch, der die Benutzung von SQLite-Datenbanken untersützt: [sqlite]
</td><td>
This aims to be a [specification] compliant OpenID connect provider with minimal footprint.
@@ -42,10 +46,16 @@ As a result, the compiled jar has a size of less than 1.5 MB!
## build
This is a gradle project. To compile it, you should have a recent version of a Java Development Kit installed.
Build the project by launching `./gradlew build` in a terminal while being in the root folder of the project.
Build the roject by launching `./gradlew build` in a terminal while being in the root folder of the project.
## database support
In order to achieve a minimal footprint, no database support is incorporated in the main branch.
However, there is SQLite support in a separate branch: [sqlite]
</td>
</tr>
</table>
[specification]: https://openid.net/specs/openid-connect-core-1_0.html
[specification]: https://openid.net/specs/openid-connect-core-1_0.html
[sqlite]: ../sqlite