From 052ed3c4be1bbedd2261bfc3aa089f4f4b44c98f Mon Sep 17 00:00:00 2001 From: squid233 <60126026+squid233@users.noreply.github.com> Date: Sun, 26 Jan 2025 22:24:19 +0800 Subject: [PATCH] docs: update README.md --- README.md | 15 +++++++++------ doc/customizer/doc_on_customizer.md | 29 ----------------------------- 2 files changed, 9 insertions(+), 35 deletions(-) delete mode 100644 doc/customizer/doc_on_customizer.md diff --git a/README.md b/README.md index 6547560f..e20c5669 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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); } ``` @@ -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` @@ -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 [JetBrains Logo (Main) logo.](https://jb.gg/OpenSourceSupport) diff --git a/doc/customizer/doc_on_customizer.md b/doc/customizer/doc_on_customizer.md deleted file mode 100644 index e1b982b5..00000000 --- a/doc/customizer/doc_on_customizer.md +++ /dev/null @@ -1,29 +0,0 @@ -# The Modules Customizer - -This documentation is for customizer in version 0.6.0. - -## Introduction - -The modules customizer is provided in order to comfort the start of users' development. - -## Selecting Version - -The latest pre-release and snapshot version are provided. - -## Selecting Modules - -Different _modules_ and CPU _architectures_ may be chosen. -The customizer includes a set of _presets_, which contains various modules that are frequently used together. - -There is a link to a table of supported architectures. -Note that if a module is selected with its unsupported architecture, -the customizer will not block you from copying the code, -but your build system will not be able to find an appropriate artifact. - -## Generated Code - -The _Gradle_ build script contains a repository for the current selected version and dependencies of selected modules. - -_VM Option_ contains a line of JVM argument to enable native access for selected modules. - -_JAR-file manifest attribute_ contains an attribute in MANIFEST.MF which just enables native access for every module.