Skip to content

Commit

Permalink
Adds docs main page
Browse files Browse the repository at this point in the history
  • Loading branch information
Jerboa-app committed Jul 30, 2024
1 parent e78b77b commit 9654378
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 21 deletions.
5 changes: 5 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#### Welcome to the documentation!

You can find the latest Doxygen docs at [https://jerboaburrow.github.io/jGL/](https://jerboaburrow.github.io/jGL/)

The API will be very unstable until 0.1.X, expect many breaking changes to then.
30 changes: 10 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,19 @@

### cross-platform graphics, abtracting OpenGL and Vulkan for 2D graphics/gamedev

This library aims to provide a simple api for graphics applications in C++, targeting multiple platforms: linux, windows, macOS, and Android
This library aims to provide a simple API for 2D graphics applications in C++, targeting multiple platforms: linux, windows, macOS, and Android (and maybe IOS).

### Docs
Versions 0.0.X will progressively define an API.

[Doxygen docs](https://jerboaburrow.github.io/jGL/)
Currently OpenGL is the main vehicle for functionality, the Vulkan backend is a shell. Once the API is reasonably solid the Vulkan side will be brought up to date for 0.1.0.

IOS depends on how easy Vulkan is to integrate with an IOS app, we may opt for https://developer.apple.com/metal/cpp/

### Documentation

[Doxygen docs are hosted here, in step with main](https://jerboaburrow.github.io/jGL/)

### Cross platform status
linux/macOS/windows: [![jGL release](https://github.com/JerboaBurrow/jGL/actions/workflows/release.yml/badge.svg)](https://github.com/JerboaBurrow/jGL/actions/workflows/release.yml)

The [release action](https://github.com/JerboaBurrow/jGL/actions/workflows/release.yml) builds the lib's for each target platform, including verifying it works as intended in a user project.

- Linux x86_64
- native build
- tested in ubuntu 22.04 LTS

- Windows
- cross-compiled from linux, via mingw-w64-x86_64
- tested with wine32/64

- macOS
- native build
- tested with MacBook Pro (a1990 emc 3215), macOS 14.0

- Android
- ndk cross-compile from linux
- currently untested
### Features
3 changes: 2 additions & 1 deletion docs/doxygen.config
Original file line number Diff line number Diff line change
Expand Up @@ -895,6 +895,7 @@ INPUT_ENCODING = UTF-8

FILE_PATTERNS = *.cpp \
*.h \
DOCUMENTATION.md

# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
Expand Down Expand Up @@ -1024,7 +1025,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE =
USE_MDFILE_AS_MAINPAGE = DOCUMENTATION.md

#---------------------------------------------------------------------------
# Configuration options related to source browsing
Expand Down

0 comments on commit 9654378

Please sign in to comment.