Skip to content

Update readme: fork main points and usage examples (issue 8) - #15

Merged
EndrII merged 2 commits into
QuasarApp:mainfrom
QuasarAppCI:task_8
Oct 13, 2026
Merged

EndrII merged 2 commits into
QuasarApp:mainfrom
QuasarAppCI:task_8

Conversation

@QuasarAppCI

Copy link
Copy Markdown
Member

Summary

Rewrites the README.md for the QuasarApp fork (issue #8):

  • Fork main points — new "About this fork" section: performance oriented (C only), Rust implementation removed (slow, 32 bit source), upstream maintainers inactive, wrappers for other languages via Merge Request.
  • Proper usage examples:
    • C and C++ API usage examples,
    • CMake consumer example: add_subdirectory() + OpenSimplex2Interface target (full consumer CMakeLists.txt),
    • manual build (cc / bundled Makefile),
    • test target usage (cmake --build build --target test).
  • Removed irrelevant upstream data: 2020-era changelog entries, renders of noise variants that are not part of the C build, area-generator note.
  • License section pointing to the LICENSE file.

The README instructions were validated against the actual repository: the CMake consumer example links OpenSimplex2Interface exactly as the build defines it, and the test target runs the OpenSimplex2tests binary (3/3 tests pass locally).

Fixes #8

- Describe the main points of this fork: performance oriented, C only, Rust removed, upstream inactive, wrappers via Merge Request

- Remove irrelevant upstream data (2020-era changelog, renders of variants absent from the C build, area-gen note)

- Add proper examples of connecting and using the library in C and C++ via CMake (consumer CMakeLists.txt + OpenSimplex2Interface target)

Fixes QuasarApp#8
@QuasarAppCI QuasarAppCI mentioned this pull request Oct 13, 2026
@QuasarAppCI

Copy link
Copy Markdown
Member Author

Status: approved and mergeable, CI green - ready for maintainer merge.

@EndrII
EndrII merged commit 9d79d73 into QuasarApp:main Oct 13, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update readme

2 participants