aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorraysan5 <raysan5@gmail.com>2014-04-19 16:36:49 +0200
committerraysan5 <raysan5@gmail.com>2014-04-19 16:36:49 +0200
commitf06a15ac8b3fe92d101ae795225fbf56fa670dba (patch)
treecdfba90ee24fd078a15c89d8753ee3e11d8e229b /README.md
parent650a8f7f159d3ce2addb1b0fdb31c3f460005391 (diff)
downloadraylib-f06a15ac8b3fe92d101ae795225fbf56fa670dba.tar.gz
raylib-f06a15ac8b3fe92d101ae795225fbf56fa670dba.zip
raylib 1.1
View CHANGELOG for a detailed list of changes
Diffstat (limited to 'README.md')
-rw-r--r--README.md71
1 files changed, 52 insertions, 19 deletions
diff --git a/README.md b/README.md
index 9dcb2a66..19c48612 100644
--- a/README.md
+++ b/README.md
@@ -23,29 +23,51 @@ a simple PONG and some of them even a BREAKOUT!
But WinBGI was not the clearer and most organized lib. There were a lot of things I found useless and
confusing and some function names were not clear enough for most of the students; not to mention points
-like no transparencies support or no hardware acceleration.
+like no transparencies support or no hardware acceleration.
So, I decided to create my own lib, hardware accelerated, clear function names, quite organized, well structured,
plain C coding and, the most important, primarily intended to LEARN videogames programming.
-I've coded quite a lot in C# and XNA and I really love it (in fact, my students learn C# with XNA after C),
+I've coded quite a lot in C# and XNA and I really love it (in fact, my students learn C# after C),
so, I decided to use C# language notation and XNA naming conventions. That way, students can jump from
-raylib to XNA (or MonoGame) extremely easily.
+raylib to XNA, MonoGame or similar libs extremely easily.
-raylib started as a weekend project and after three months of hard work, here it is the first version.
+raylib started as a weekend project and after three months of hard work, first version was published.
+
+Enjoy it.
+
+notes on raylib 1.1
+-------------------
+
+On April 2014, after 6 month of first raylib release, raybil 1.1 has been released. This new version presents a
+complete internal redesign of the library to support OpenGL 1.1, OpenGL 3.3+ and OpenGL ES 2.0.
+
+A new module named [rlgl] (https://github.com/raysan5/raylib/blob/master/src/rlgl.h) has been added to the library. This new module translate raylib-OpenGL-style
+immediate mode functions (i.e. rlVertex3f(), rlBegin(), ...) to different versions of OpenGL (1.1, 3.3+, ES2), selectable by one define.
+
+[rlgl] (https://github.com/raysan5/raylib/blob/master/src/rlgl.h) also comes with a second new module named [raymath] (https://github.com/raysan5/raylib/blob/master/src/raymath.h), which includes
+a bunch of useful functions for 3d-math with vectors, matrices and quaternions.
+
+Some other big changes of this new version have been the support for OGG files loading and stream playing, and the
+support of DDS texture files (compressed and uncompressed) along with mipmaps support.
+
+Lots of code changes and lot of testing have concluded in this amazing new raylib 1.1.
Enjoy it.
features
--------
-
- * Written in plain C code (C99)
- * Uses C# PascalCase/camelCase notation
- * Hardware accelerated using OpenGL 1.1
- * Transparencies support (RGBA Colors)
- * Custom color palette for better use on white background
- * Basic 3D Support (camera, basic models, OBJ models, etc)
- * Powerful Text module with SpriteFonts support
+
+ * Written in plain C code (C99)
+ * Uses C# PascalCase/camelCase notation
+ * Hardware accelerated with OpenGL (1.1, 3.3+ or ES2)
+ * Unique OpenGL abstraction layer [rlgl]
+ * Powerful fonts module with SpriteFonts support
+ * Multiple textures support, including DDS and mipmaps generation
+ * Basic 3d support for Shapes, Models, Heightmaps and Billboards
+ * Powerful math module for Vector and Matrix operations [raymath]
+ * Audio loading and playing with streaming support
+ * Custom color palette for fancy visuals on raywhite background
raylib uses on its core module the outstanding [GLFW3] (http://www.glfw.org/) library. The best option by far I found for
window/context and input management (clean, focused, great license, well documented, modern, ...).
@@ -75,19 +97,30 @@ raylib could be build with the following command lines (Using GCC compiler):
gcc -c core.c -std=c99 -Wall
gcc -c shapes.c -std=c99 -Wall
gcc -c textures.c -std=c99 -Wall
- gcc -c stb_image.c -std=c99 -Wall
gcc -c text.c -std=c99 -Wall
gcc -c models.c -std=c99 -Wall
- gcc -c vector3.c -std=c99 -Wall
+ gcc -c raymath.c -std=c99 -Wall
+ gcc -c rlgl.c -std=c99 -Wall
gcc -c audio.c -std=c99 -Wall
gcc -c utils.c -std=c99 -Wall
- ar rcs raylib.a core.o shapes.o textures.o stb_image.o text.o models.o vector3.o utils.o audio.o
+ gcc -c stb_image.c -std=c99 -Wall
+ gcc -c stb_vorbis.c -std=c99 -Wall
+
+ ar rcs libraylib.a core.o shapes.o textures.o stb_image.o text.o models.o raymath.o rlgl.o utils.o stb_vorbis.o audio.o
+
+To compile examples, make sure raylib.h is placed in the include path and the following libraries are placed in the libraries path:
-To compile examples, make sure raylib.h is placed in include path and libraries raylib (libraylib.a) and glfw3 (libglfw3.a)
-are placed in the libraries path. It's also recommended to link with file icon.o for fancy raylib icon usage.
+ libraylib.a - raylib
+ libglfw3.a - GLFW3 (static version)
+ libglew32.a - GLEW, OpenGL extension loading, only required if using OpenGL 3.3+ or ES2
+ libopenal32.a - OpenAL, audio device management
+
+It's also recommended to link with file icon.o for fancy raylib icon usage. Linking command:
cd raylib/examples
- gcc -o test_code.exe test_code.c icon.o -lraylib -lglfw3 -lopengl32 -lgdi32 -std=c99 -Wl,--subsystem,windows
+ gcc -o test_code.exe test_code.c icon.o -lraylib -lglfw3 -lglew32 -lopenal32 -lopengl32 -lgdi32 -std=c99 -Wl,--subsystem,windows
+
+If you have any doubt, [let me know][raysan5].
contact
-------
@@ -109,4 +142,4 @@ The following people have contributed in some way to make raylib project a reali
- [Elendow](http://www.elendow.com)
-[raysan5]: mailto:raysan@raysanweb.com "Ramon Santamaria - Ray San"
+[raysan5]: mailto:raysan5@gmail.com "Ramon Santamaria - Ray San"