add readme and add license notices

README.md

@@ -2,4 +2,57 @@
 
 # MineMark
 Java Markdown Rendering library
-</div>
+</div>
+
+## Usage
+MineMark is build in a modular system, `minemark-core` is the hearth of everything, it is responsible for parsing 
+the markdown and generating a layout for it. Then you need a rendering implementation to actually render the markdown.
+Currently, only an elementa render system is provided, but it is relatively fast to create your own rendering 
+implementation if you wish to do that.
+
+Adding MineMark as a dependency:
+```kt
+repositories {
+    maven("https://maven.dediamondpro.dev/releases")
+}
+
+dependencies {
+    // Add the core as a dependency
+    implementation("dev.dediamondpro:minemark-core:1.0.0")
+    // Add elementa rendering implementation as a dependency
+    implementation("dev.dediamondpro:minemark-elementa:1.0.0")
+}
+```
+
+How you render a markdown element will differ from one rendering implementation to another, here is an example of how 
+you would do it with the elementa rendering implementation:
+```kt
+MineMarkComponent("This *is* **were** you input your markdown!").constrain {
+    x = 0.pixels()
+    y = 0.pixels()
+    width = 600.pixels()
+} childOf window
+```
+
+## Creating your own rendering implementation
+To create your own rendering implementation, you first have to implement the rendering of the elements you want to 
+support. You can choose what elements you implement, the only requirement is that **you have to provide a text element**.
+To implement an element, you have to extend its abstract form, for an example for each element I would recommend you
+look at the elementa implementation as a reference. An element takes 2 type variables, the first one (S) is the style,
+so you have to create a class that implements the `Style` interface. The second can be any class, it is given to your
+elements at render time. If you do not wish to use this you can just set it to be an `Object`.
+
+Once you implemented the elements you want, you have to register them in a core. You can do this as follows:
+```java
+MineMarkCore<MyStyle, MyRenderObject> core = MineMarkCore.<MyStyle, MyRenderObject>builder()
+        // Set the text element to your text element
+        .setTextElement(MyTextElement)
+        // Set the image element to your image element
+        .addElement(Elements.IMAGE, MyImageElement)
+        // Set an element with the html tag "myHtmlTag" to MyElement
+        .addElement(Arrays.asList("myHtmlTag"), MyElement)
+        .build();
+```
+
+Then you have to call `core.parse(myStyle, markdown)` to parse the markdown, this will return a `MineMarkElement`.
+This element has a `draw`, `beforeDraw` and `onMouseClick` method that should be called by your rendering implementation.

build.gradle.kts

@@ -1,10 +1,27 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 plugins {
     id("java-library")
     id("maven-publish")
 }
 
 group = "dev.dediamondpro"
-version = "1.0-SNAPSHOT112"
+version = "1.0.0"
 
 repositories {
     mavenCentral()

elementa/build.gradle.kts

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 plugins {
     // Lowest kotlin version that elementa supports
     kotlin("jvm") version "1.6.10"

elementa/src/main/kotlin/dev/dediamondpro/minemark/elementa/MineMarkComponent.kt

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 package dev.dediamondpro.minemark.elementa
 
 import dev.dediamondpro.minemark.MineMarkCore
@@ -13,6 +30,10 @@ import gg.essential.universal.UMatrixStack
 import org.commonmark.ext.gfm.strikethrough.StrikethroughExtension
 import org.commonmark.ext.gfm.tables.TablesExtension
 
+
+/**
+ * A component to rendering markdown powered by MineMark
+ */
 class MineMarkComponent(
     markdown: String,
     style: MarkdownStyle = MarkdownStyle(),

elementa/src/main/kotlin/dev/dediamondpro/minemark/elementa/elements/MarkdownBlockquoteComponent.kt

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 package dev.dediamondpro.minemark.elementa.elements
 
 import dev.dediamondpro.minemark.LayoutStyle

elementa/src/main/kotlin/dev/dediamondpro/minemark/elementa/elements/MarkdownCodeBlockComponent.kt

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 package dev.dediamondpro.minemark.elementa.elements
 
 import dev.dediamondpro.minemark.LayoutStyle

elementa/src/main/kotlin/dev/dediamondpro/minemark/elementa/elements/MarkdownHeadingComponent.kt

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 package dev.dediamondpro.minemark.elementa.elements
 
 import dev.dediamondpro.minemark.LayoutStyle

elementa/src/main/kotlin/dev/dediamondpro/minemark/elementa/elements/MarkdownHorizontalRuleComponent.kt

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 package dev.dediamondpro.minemark.elementa.elements
 
 import dev.dediamondpro.minemark.LayoutStyle

elementa/src/main/kotlin/dev/dediamondpro/minemark/elementa/elements/MarkdownImageComponent.kt

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 package dev.dediamondpro.minemark.elementa.elements
 
 import dev.dediamondpro.minemark.LayoutStyle

elementa/src/main/kotlin/dev/dediamondpro/minemark/elementa/elements/MarkdownListElementComponent.kt

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 package dev.dediamondpro.minemark.elementa.elements
 
 import dev.dediamondpro.minemark.LayoutData

elementa/src/main/kotlin/dev/dediamondpro/minemark/elementa/elements/MarkdownTableCellComponent.kt

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 package dev.dediamondpro.minemark.elementa.elements
 
 import dev.dediamondpro.minemark.LayoutStyle

elementa/src/main/kotlin/dev/dediamondpro/minemark/elementa/elements/MarkdownTextComponent.kt

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 package dev.dediamondpro.minemark.elementa.elements
 
 import dev.dediamondpro.minemark.LayoutData

elementa/src/main/kotlin/dev/dediamondpro/minemark/elementa/style/MarkdownStyle.kt

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 package dev.dediamondpro.minemark.elementa.style
 
 import dev.dediamondpro.minemark.elementa.util.ElementaBrowserProvider

elementa/src/main/kotlin/dev/dediamondpro/minemark/elementa/util/ElementaBrowserProvider.kt

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 package dev.dediamondpro.minemark.elementa.util
 
 import dev.dediamondpro.minemark.providers.BrowserProvider

elementa/src/main/kotlin/dev/dediamondpro/minemark/elementa/util/EmptyImage.kt

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 package dev.dediamondpro.minemark.elementa.util
 
 import gg.essential.elementa.components.image.ImageProvider

settings.gradle.kts

@@ -1,3 +1,20 @@
+/*
+ * This file is part of MineMark
+ * Copyright (C) 2024 DeDiamondPro
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 3 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
 dependencyResolutionManagement {
     versionCatalogs {
         create("libs")