diff --git a/README.md b/README.md index 619e83b83..a581476ce 100644 --- a/README.md +++ b/README.md @@ -21,46 +21,42 @@ Ready to learn? Jump to [code examples!](http://www.raylib.com/examples.html) features -------- - **NO external dependencies**, all required libraries are bundled into raylib - - Multiple platforms supported: **Windows, Linux, MacOS, Android... and many more!** + - Multiple platforms supported: **Windows, Linux, MacOS, Android, HTML5... and 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) + - Multiple **Fonts** formats supported (TTF, XNA fonts, AngelCode fonts) - Outstanding texture formats support, including compressed formats (DXT, ETC, ASTC) - **Full 3D support**, including 3D Shapes, Models, Billboards, Heightmaps and more! - Flexible Materials system, supporting classic maps and **PBR maps** - **Animated 3D models** supported (skeletal bones animation) - - Shaders support, including model and postprocessing shaders. + - Shaders support, 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 - - Huge examples collection with [+95 code examples](https://www.raylib.com/examples.html)! - - Bindings to [+25 programming languages](https://github.com/raysan5/raylib/blob/master/BINDINGS.md)! - + - Huge examples collection with [+115 code examples](https://github.com/raysan5/raylib/tree/master/examples)! + - Bindings to [+40 programming 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 in the form of [rglfw](https://github.com/raysan5/raylib/blob/master/src/rglfw.c) module, to avoid external dependencies. raylib uses on its [raudio](https://github.com/raysan5/raylib/blob/master/src/raudio.c) module, the amazing [miniaudio](https://github.com/dr-soft/miniaudio) library to support multiple platforms and multiple audio backends. -raylib uses internally multiple single-file header-only libraries to support different fileformats loading and saving, all those libraries are embedded with raylib and available in [src/external](https://github.com/raysan5/raylib/tree/master/src/external) directory. Check [raylib Wiki](https://github.com/raysan5/raylib/wiki/raylib-dependencies) for a detailed list. +raylib uses internally several single-file header-only libraries to support different fileformats loading and saving, all those libraries are embedded with raylib and available in [src/external](https://github.com/raysan5/raylib/tree/master/src/external) directory. Check [raylib Wiki](https://github.com/raysan5/raylib/wiki/raylib-dependencies) for a detailed list. -*On Android platform, `native_app_glue module` module (provided by Android NDK) and native Android libraries are used to manage window/context, inputs and activity life cycle.* +*On Android platform, `native_app_glue` module (provided by Android NDK) and native Android libraries are used to manage window/context, inputs and activity life cycle.* *On Raspberry Pi platform (native mode), `Videocore API` and `EGL` libraries are used for window/context management. Inputs are processed using `evdev` Linux libraries* +*On Web platform, raylib uses `emscripten` provided libraries for several input events management, specially noticeable the touch events support.* + build and installation ---------------------- -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. Check [raylib Wiki](https://github.com/raysan5/raylib/wiki) for more info. +raylib 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](https://github.com/raysan5/raylib/issues/613) on multiple OS distributions. -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. +If you wish to build raylib yourself, [raylib Wiki](https://github.com/raysan5/raylib/wiki#development-platforms) contains detailed instructions on building and using raylib on multiple platforms. -raylib has been developed using 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/) - -Those are the tools recommended to enjoy raylib development. +raylib can be used with multiple IDEs, [projects directory](https://github.com/raysan5/raylib/tree/master/projects) includes several ready-to-use project templates to build raylib and code examples. contact ------- @@ -73,7 +69,7 @@ contact * Patreon: [https://www.patreon.com/raylib](https://www.patreon.com/raylib) * YouTube: [https://www.youtube.com/channel/raylib](https://www.youtube.com/channel/UC8WIBkhYb5sBNqXO1mZ7WSQ) -If you are using raylib and you enjoy it, please, join our [Discord server](https://discord.gg/VkzNHUE). +If you are using raylib and enjoying it, please, join our [Discord server](https://discord.gg/VkzNHUE) and let us know! license -------