Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
squid233 committed Jan 26, 2025
1 parent 9089662 commit 052ed3c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 35 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@ void main() {
// invoke native functions via static methods
glfwInit();
// use MemorySegment to represent memory addresses
MemorySegment window = glfwCreateWindow(...);
MemorySegment window = glfwCreateWindow(
800, 600,
// use MemoryUtil::allocString to allocate string and manage by GC
MemoryUtil.allocString("Title"),
MemorySegment.NULL,
MemorySegment.NULL
);

int width, height;
// use MemoryStack for one-time and quick allocation
Expand All @@ -31,9 +37,9 @@ void main() {
height = pHeight.get(ValueLayout.JAVA_INT, 0L);
}

// for OpenGL and Vulkan, create instances of wrappers
// for OpenGL, create instance of wrappers
var gl = new GL(GLFW::glfwGetProcAddress);
// invoke OpenGL/Vulkan functions via instance methods
// invoke OpenGL functions via instance methods
gl.ClearColor(0.0f, 0.0f, 0.0f, 1.0f);
}
```
Expand Down Expand Up @@ -63,7 +69,6 @@ Feel free to ask questions as long as you have searched in discussions and found
## Import as a Dependency

We provided a modules customizer [here](https://over-run.github.io/overrungl-gen/).
A documentation of the customizer is [here](doc/customizer/doc_on_customizer.md).

- Platform Maven coordinate: `io.github.over-run:overrungl-bom`
- Core module Maven coordinate: `io.github.over-run:overrungl`
Expand Down Expand Up @@ -152,8 +157,6 @@ See [doc/notes](doc/notes/README.md).

The latest Javadoc can be found [here](https://over-run.github.io/overrungl/).

The documentation of OpenGL can be found from [Khronos' references](https://registry.khronos.org/OpenGL-Refpages/gl4/) and [docs.gl](https://docs.gl/).

### Credits

[<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." width="128" height="128">](https://jb.gg/OpenSourceSupport)
29 changes: 0 additions & 29 deletions doc/customizer/doc_on_customizer.md

This file was deleted.

0 comments on commit 052ed3c

Please sign in to comment.