Bläddra i källkod

More info on how to use the library

rexim 3 år sedan
förälder
incheckning
dd37029f99
1 ändrade filer med 35 tillägg och 2 borttagningar
  1. 35 2
      README.md

+ 35 - 2
README.md

@@ -4,10 +4,43 @@ Simple 2D Graphics Library for C.
 
 ## Quick Start
 
+### Test the Library
+
 ```console
 $ ./build.sh
-$ ./bin/test
-$ ./bin/example
+```
+
+### Use the Library
+
+> The truly reusable code is the one that you can simply copy-paste.
+
+Copy-paste [./olive.c](./olive.c) to your project.
+
+```c
+// flag_jp.c
+#include "olive.c"
+
+#define STB_IMAGE_WRITE_IMPLEMENTATION
+#include "stb_image_write.h"
+
+#define WIDTH 900
+#define HEIGHT 600
+
+uint32_t pixels[WIDTH*HEIGHT];
+
+int main(void)
+{
+    // Taken from https://upload.wikimedia.org/wikipedia/en/9/9e/Flag_of_Japan.svg
+    olivec_fill(pixels, WIDTH, HEIGHT, 0xFFFFFFFF);
+    olivec_fill_circle(pixels, WIDTH, HEIGHT, WIDTH/2, HEIGHT/2, 180, 0xFF2D00BC);
+
+    const char *file_path = "flag_jp.png";
+    if (!stbi_write_png(file_path, WIDTH, HEIGHT, 4, pixels, sizeof(uint32_t)*WIDTH)) {
+        fprintf(stderr, "ERROR: could not write %s\n", file_path);
+        return 1;
+    }
+    return 0;
+}
 ```
 
 ## Gallery