Skip to content

Commit fab2821

Browse files
remove cheatsheets until we can ensure they stay up to date by generating them from api.json
1 parent 85061cc commit fab2821

10 files changed

+12
-1466
lines changed

doc/QuickStart.md

+9-18
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
1-
--------
2-
**DISCLAIMER: This project is very much a Work In Progress. Expect bugs, missing and/or incomplete features, unstable APIs, and sparse documentation. Some current issues might be a show stopper for you, so make sure you can build and run the sample apps before jumping in.**
31

4-
**If you do choose to try out Orca anyway, well thanks! We'll do our best to answer your questions, and we'd really appreciate to hear your feedback!**
5-
6-
--------
7-
8-
# Orca Quick Start Guide
2+
# Quick Start
93

104
This is a short introduction to developing an application that can be run by the Orca runtime. We'll present the basic structure of an Orca application, and walk through a simple example in C.
115

12-
Please make sure your system fulfills the requirements outlined in the [Readme](./Readme.md).
13-
146
## What is an Orca app?
157

168
An Orca app is a WebAssembly module designed for the Orca runtime. Your app interacts with the Orca runtime via WebAssembly imports and exports. For example, you can import functions from the Orca runtime to get user input, and export functions to the Orca runtime to draw to the screen.
@@ -76,8 +68,6 @@ Handlers are optional. If you don't care about an event, you can just omit the a
7668
- `oc_on_init()` is called once when your application starts and can be use to initialize your application's resources.
7769
- `oc_on_frame_refresh()` is called when your application needs to render a new frame, typically tied to the refresh rate of the monitor.
7870
79-
For a list of available handlers and their signatures, see the [app cheatsheet](../doc/cheatsheets/cheatsheet_app.h).
80-
8171
8272
## Clock example
8373
@@ -153,7 +143,8 @@ oc_set_color_rgba(1, 1, 1, 1);
153143
oc_circle_fill(centerX, centerY, clockRadius);
154144
```
155145
156-
For a list of canvas drawing functions, see the [graphics API cheatsheet](../doc/cheatsheets/cheatsheet_graphics.h).
146+
For a list of canvas drawing functions, see the [graphics API documentation](https://docs.orca-app.dev/api/Graphics/Canvas%20API/).
147+
157148
158149
#### Transforms
159150
@@ -234,13 +225,13 @@ You can unconditionally abort the application with a message box using `OC_ABORT
234225
235226
## Where to go next?
236227
237-
For more examples of how to use Orca APIs, you can look at the other [sample apps](../samples):
228+
For more examples of how to use Orca APIs, you can look at the other [sample apps](https://github.com/orca-app/orca/tree/main/samples):
238229
239-
- [breakout](../samples/breakout) is a mini breakout game making use of the vector graphics API. It demonstrates using input and drawing images.
240-
- [triangle](../samples/triangle) shows how to draw a spining triangle using the GLES API.
241-
- [fluid](../samples/fluid) is a fluid simulation using a more complex GLES setup.
242-
- [ui](../samples/ui) showcases the UI API and Orca's default UI widgets.
230+
- [breakout](https://github.com/orca-app/orca/tree/main/samples/breakout) is a mini breakout game making use of the vector graphics API. It demonstrates using input and drawing images.
231+
- [triangle](https://github.com/orca-app/orca/tree/main/samples/triangle) shows how to draw a spining triangle using the GLES API.
232+
- [fluid](https://github.com/orca-app/orca/tree/main/samples/fluid) is a fluid simulation using a more complex GLES setup.
233+
- [ui](https://github.com/orca-app/orca/tree/main/samples/ui) showcases the UI API and Orca's default UI widgets.
243234
244-
For a list of Orca APIs, you can look at the [API cheatsheets](../doc/cheatsheets).
235+
For a list of Orca APIs, you can look at the [API reference](https://docs.orca-app.dev/api/api_reference/).
245236
246237
You can also ask questions in the [Handmade Network Discord](https://discord.gg/hmn), in particular in the [#orca](https://discord.com/channels/239737791225790464/1121811864066732082) channel.

doc/UIColors.md

-7
This file was deleted.

doc/cheatsheets/cheatsheet_app.h

-35
This file was deleted.

doc/cheatsheets/cheatsheet_graphics.h

-196
This file was deleted.

doc/cheatsheets/cheatsheet_io.h

-39
This file was deleted.

0 commit comments

Comments
 (0)