aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRay <raysan5@gmail.com>2019-03-25 10:12:38 +0100
committerRay <raysan5@gmail.com>2019-03-25 10:12:38 +0100
commit86ef08c4082ab5b4214b6f0e9abd2905c19c0be7 (patch)
tree1216926af90a81b9c9f1ec5fac8a4d1d5ff4e06b
parentb0bfe5812fafd9b35057af4880311d7796ac61fd (diff)
downloadraylib-86ef08c4082ab5b4214b6f0e9abd2905c19c0be7.tar.gz
raylib-86ef08c4082ab5b4214b6f0e9abd2905c19c0be7.zip
Update README.md
-rw-r--r--README.md30
1 files changed, 16 insertions, 14 deletions
diff --git a/README.md b/README.md
index b11665c8..ba7f5389 100644
--- a/README.md
+++ b/README.md
@@ -4,11 +4,13 @@
raylib is highly inspired by Borland BGI graphics lib and by XNA framework.
-raylib could be useful for prototyping, tools development, graphic applications, embedded systems and education.
+raylib is especially well suited for prototyping, tooling, graphical applications, embedded systems and education.
NOTE for ADVENTURERS: raylib is a programming library to enjoy videogames programming;
no fancy interface, no visual helpers, no auto-debugging... just coding in the most
-pure spartan-programmers way. Are you ready to learn? Jump to [code examples!](http://www.raylib.com/examples.html)
+pure spartan-programmers way.
+
+Ready to learn? Jump to [code examples!](http://www.raylib.com/examples.html)
[![Build Status](https://travis-ci.org/raysan5/raylib.svg?branch=master)](https://travis-ci.org/raysan5/raylib)
[![https://ci.appveyor.com/api/projects/status/github/raysan5/raylib?svg=true](https://ci.appveyor.com/api/projects/status/github/raysan5/raylib?svg=true)](https://ci.appveyor.com/project/raysan5/raylib)
@@ -18,20 +20,20 @@ pure spartan-programmers way. Are you ready to learn? Jump to [code examples!](h
features
--------
- - **NO external dependencies**, all required libraries included with raylib
+ - **NO external dependencies**, all required libraries are bundled into raylib
- Multiple platforms supported: **Windows, Linux, MacOS, Android... and many more!**
- Written in plain C code (C99) in PascalCase/camelCase notation
- Hardware accelerated with OpenGL (**1.1, 2.1, 3.3 or ES 2.0**)
- **Unique OpenGL abstraction layer** (usable as standalone module): [rlgl](https://github.com/raysan5/raylib/blob/master/src/rlgl.h)
- Multiple Fonts formats supported (XNA fonts, AngelCode fonts, TTF)
- Outstanding texture formats support, including compressed formats (DXT, ETC, ASTC)
- - **Full 3d support** for 3d Shapes, Models, Billboards, Heightmaps and more!
+ - **Full 3D support**, including 3D Shapes, Models, Billboards, Heightmaps and more!
- Flexible Materials system, supporting classic maps and **PBR maps**
- - Shaders support, including Model shaders and Postprocessing shaders
+ - Custom shaders, including model and postprocessing shaders.
- **Powerful math module** for Vector, Matrix and Quaternion operations: [raymath](https://github.com/raysan5/raylib/blob/master/src/raymath.h)
- Audio loading and playing with streaming support (WAV, OGG, MP3, FLAC, XM, MOD)
- **VR stereo rendering** support with configurable HMD device parameters
- - Bindings to **Lua** ([raylib-lua](https://github.com/raysan5/raylib-lua)), **Go** ([raylib-go](https://github.com/gen2brain/raylib-go)) and [more](https://github.com/raysan5/raylib/blob/master/CONTRIBUTING.md#raylib-bindings)!
+ - Bindings to [multiple code languages](https://github.com/raysan5/raylib/blob/master/BINDINGS.md)!
raylib uses on its [core](https://github.com/raysan5/raylib/blob/master/src/core.c) module the outstanding [GLFW3](http://www.glfw.org/) library, embedded inside raylib in the form of [rglfw](https://github.com/raysan5/raylib/blob/master/src/rglfw.c) module, avoiding that way external dependencies.
@@ -46,16 +48,16 @@ raylib uses internally multiple single-file header-only libraries to support mul
build and installation
----------------------
-Binary releases for Windows, Linux and macOS are available at the [Github Releases](https://github.com/raysan5/raylib/releases) page. raylib is also available via multiple package managers on multiple OS distributions. For more info check [raylib Wiki](https://github.com/raysan5/raylib/wiki).
+Binary releases for Windows, Linux and macOS are available at the [Github Releases page](https://github.com/raysan5/raylib/releases). raylib is also available via multiple package managers on multiple OS distributions. For more info check [raylib Wiki](https://github.com/raysan5/raylib/wiki).
+
+If you wish to build raylib yourself, [the raylib Wiki](https://github.com/raysan5/raylib/wiki) also contains detailed instructions on how to approach that.
-To build raylib yourself, check out also the [raylib Wiki](https://github.com/raysan5/raylib/wiki) for detailed instructions.
+raylib has been developed exclusively using two tools:
-raylib has been developed using exclusively two tools:
+ * Notepad++ (text editor) - [http://notepad-plus-plus.org](http://notepad-plus-plus.org/)
+ * MinGW (GCC compiler) - [http://www.mingw.org](http://www.mingw.org/)
- * Notepad++ (text editor) - [http://notepad-plus-plus.org/](http://notepad-plus-plus.org/)
- * MinGW (GCC compiler) - [http://www.mingw.org/](http://www.mingw.org/)
-
-Those are the tools recommended to develop with raylib, in fact, those are the tools my students use.
+Those tools are recommended for raylib development.
contact
-------
@@ -71,7 +73,7 @@ contact
If you are using raylib and you enjoy it, please, [let me know][raysan5].
-If you feel you can help, then, [helpme!](http://www.raylib.com/helpme.html)
+If you are able to contribute, then please [helpme](http://www.raylib.com/helpme.html)!
license
-------