mirrors/raylib
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated common documents

Browse Source
This commit is contained in:
Ray 2018-07-16 02:07:48 +02:00
parent d127d8e9f8
commit c5f65c0b16
5 changed files with 38 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG
View File

@ -1,10 +1,10 @@
changelog changelog
--------- ---------
Current Release: raylib 1.8.0 (Oct 2017) Current Release: raylib 2.0.0 (July 2018)
----------------------------------------------- -----------------------------------------------
Release: raylib 2.0 (June 2017 ?) Release: raylib 2.0 (July 2018)
----------------------------------------------- -----------------------------------------------
KEY CHANGES: KEY CHANGES:
- Removed external dependencies (GLFW3 and OpenAL) - Removed external dependencies (GLFW3 and OpenAL)

18
CONTRIBUTING.md
View File

@ -21,7 +21,7 @@ Use your best judgement, and feel free to propose changes to this document in a
- [raylib roadmap](ROADMAP.md) - [raylib roadmap](ROADMAP.md)
[raylib Wiki](https://github.com/raysan5/raylib/wiki) contains some information about the library and is open to anyone for edit. [raylib Wiki](https://github.com/raysan5/raylib/wiki) contains some information about the library and is open to anyone for edit.
Feel free to review it if required, just take care not to break anything. Feel free to review it if required, just take care not to break something.
### raylib C coding conventions ### raylib C coding conventions
@ -66,6 +66,8 @@ Some people ported raylib to other languages in form of bindings or wrappers to
- [raylib Crystal binding](https://gitlab.com/Zatherz/cray) - [raylib Crystal binding](https://gitlab.com/Zatherz/cray)
- [raylib Perl wrapper](https://metacpan.org/pod/Graphics::Raylib) - [raylib Perl wrapper](https://metacpan.org/pod/Graphics::Raylib)
- raylib Pascal binding with custom IDE (closed-source) - raylib Pascal binding with custom IDE (closed-source)
- [raylib flat-assembler Usage example] (http://forum.raylib.com/index.php?p=/discussion/comment/425/#Comment_425)
- [raylib COBOL Usage example](https://github.com/Martinfx/Cobol/tree/master/OpenCobol/Games/raylib)
Usually, raylib bindings follow the convention: `raylib-{language}` Usually, raylib bindings follow the convention: `raylib-{language}`
@ -78,7 +80,7 @@ If you have any doubt, don't hesitate to [contact me](mailto:ray@raylib.com)!.
You can write me a direct mail but you can also contact me on the following networks: You can write me a direct mail but you can also contact me on the following networks:
- [raylib forum](http://forum.raylib.com/) - A good place for discussions or to ask for help. - [raylib forum](http://forum.raylib.com/) - A good place for discussions or to ask for help.
- [raylib gitter](https://gitter.im/raylib) - A direct communication channel for project discussions. - [raylib Discord](https://discord.gg/VkzNHUE) - A direct communication channel for project discussions.
- [raylib twitter](https://twitter.com/raysan5) - My personal twitter account, I usually post about raylib, you can send me PMs. - [raylib twitter](https://twitter.com/raysan5) - My personal twitter account, I usually post about raylib, you can send me PMs.
- [raylib web](http://www.raylib.com/) - On top-right corner there is a bunch of networks where you can find me. - [raylib web](http://www.raylib.com/) - On top-right corner there is a bunch of networks where you can find me.
@ -115,14 +117,20 @@ contributing (in some way or another) to make the raylib project better. Huge th
- [Joel Davis](https://github.com/joeld42) for adding raycast picking utilities and a [great example](https://github.com/raysan5/raylib/blob/master/examples/models/models_mesh_picking.c) - [Joel Davis](https://github.com/joeld42) for adding raycast picking utilities and a [great example](https://github.com/raysan5/raylib/blob/master/examples/models/models_mesh_picking.c)
- [Richard Goodwin](https://github.com/AudioMorphology) for adding RPI touchscreen support - [Richard Goodwin](https://github.com/AudioMorphology) for adding RPI touchscreen support
- [Milan Nikolic](https://github.com/gen2brain) for adding Android build support with custom standalone toolchain - [Milan Nikolic](https://github.com/gen2brain) for adding Android build support with custom standalone toolchain
- [Michael Vetter](https://github.com/jubalh) for improvements on build system and adding meson support for Linux - [Michael Vetter](https://github.com/jubalh) for improvements on build system and his work on Suse Linux package... and multiple fixes!
- [Wilhem Barbier](https://github.com/nounoursheureux) for adding Image generation functions and some fixes - [Wilhem Barbier](https://github.com/nounoursheureux) for adding Image generation functions and some fixes
- [Benjamin Summerton](https://github.com/define-private-public) for improving OSX building and his amazing work on CMake build sytem - [Benjamin Summerton](https://github.com/define-private-public) for improving OSX building and his amazing work on CMake build sytem
- [MartinFX](https://github.com/Martinfx) for adding compilation support for FreeBSD OS - [MartinFX](https://github.com/Martinfx) for adding compilation support for FreeBSD OS and derivatives
- [Wilhem Barbier](https://github.com/nounoursheureux) for supporting default shaders on shader loading, if shader not provided - [Wilhem Barbier](https://github.com/nounoursheureux) for supporting default shaders on shader loading, if shader not provided
- [Ahmad Fatoum](https://github.com/a3f) for implementing continuus integration support for raylib (Travis and AppVeyor) and greatly improving build system. - [Ahmad Fatoum](https://github.com/a3f) for implementing continuus integration support for raylib (Travis and AppVeyor) and greatly improving build system.
- [SamNChiet](https://github.com/SamNChiet) for his work on UWP inputs implementation. - [SamNChiet](https://github.com/SamNChiet) for his work on UWP inputs implementation.
- [David Reid](https://github.com/mackron) for a complete review of audio module to support his amazing mini_al audio library. - [David Reid](https://github.com/mackron) for a complete review of audio module to support his amazing mini_al audio library.
- [Kai](https://github.com/questor) for multiple code reviews and improvements. - [Kai](https://github.com/questor) for multiple code reviews and improvements.
- [RDR8](https://github.com/RDR8) for his work on Makefiles for Linux
- [Max Danielsson](https://github.com/autious) for adding support for orthographic 3d camera projection
- [Lumaio](https://github.com/TheLumaio) for his great work on GBuffers and GetCollisionRayModel()
- [Jonas Daeyaert](https://github.com/culacant) for his amazing work on IQM animated models support
- [Seth Archambault](https://github.com/SethArchambault) for his work on Android Gamepad support (SNES model)
- [D3nX](https://github.com/D3nX) for adding Code::Blocks project template.
Please, if I forget someone in this list, excuse me and write me an email to remind me to add you! Please, if I forget someone in this list, excuse me and send a PR!

2
HELPME.md
View File

@ -33,5 +33,7 @@ contact
* Reddit: [https://www.reddit.com/r/raylib](https://www.reddit.com/r/raylib) * Reddit: [https://www.reddit.com/r/raylib](https://www.reddit.com/r/raylib)
* Twitch: [http://www.twitch.tv/raysan5](http://www.twitch.tv/raysan5) * Twitch: [http://www.twitch.tv/raysan5](http://www.twitch.tv/raysan5)
* Patreon: [https://www.patreon.com/raylib](https://www.patreon.com/raylib) * Patreon: [https://www.patreon.com/raylib](https://www.patreon.com/raylib)
* Discord: [https://discord.gg/raylib](https://discord.gg/VkzNHUE)
* YouTube: [https://www.youtube.com/channel/raylib](https://www.youtube.com/channel/UC8WIBkhYb5sBNqXO1mZ7WSQ)
[raysan5]: mailto:ray@raylib.com "Ramon Santamaria - Ray San" [raysan5]: mailto:ray@raylib.com "Ramon Santamaria - Ray San"

32
README.md
View File

@ -18,21 +18,20 @@ pure spartan-programmers way. Are you ready to learn? Jump to [code examples!](h
features features
-------- --------
- **NO external dependencies**, all required libraries included with raylib
* Written in plain C code (C99) in PascalCase/camelCase notation - Multiple platforms supported: **Windows, Linux, MacOS, Android... and many more!**
* Hardware accelerated with OpenGL (1.1, 2.1, 3.3 or ES2 - choose at compile) - Written in plain C code (C99) in PascalCase/camelCase notation
* Unique OpenGL abstraction layer (usable as standalone module): [rlgl](https://github.com/raysan5/raylib/blob/master/src/rlgl.c) - Hardware accelerated with OpenGL (**1.1, 2.1, 3.3 or ES 2.0**)
* Powerful fonts module with SpriteFonts support (XNA fonts, AngelCode fonts, TTF) - **Unique OpenGL abstraction layer** (usable as standalone module): [rlgl](https://github.com/raysan5/raylib/blob/master/src/rlgl.c)
* Outstanding texture formats support, including compressed formats (DXT, ETC, ASTC) - Multiple Fonts formats supported (XNA fonts, AngelCode fonts, TTF)
* Full 3d support for 3d Shapes, Models, Billboards, Heightmaps and more! - Outstanding texture formats support, including compressed formats (DXT, ETC, ASTC)
* Flexible Materials system, supporting classic maps and PBR maps - **Full 3d support** for 3d Shapes, Models, Billboards, Heightmaps and more!
* Shaders support, including Model shaders and Postprocessing shaders - Flexible Materials system, supporting classic maps and **PBR maps**
* Powerful math module for Vector, Matrix and Quaternion operations: [raymath](https://github.com/raysan5/raylib/blob/master/src/raymath.h) - Shaders support, including Model shaders and Postprocessing shaders
* Audio loading and playing with streaming support (WAV, OGG, FLAC, XM, MOD) - **Powerful math module** for Vector, Matrix and Quaternion operations: [raymath](https://github.com/raysan5/raylib/blob/master/src/raymath.h)
* Multiple platforms support: Windows, Linux, FreeBSD, OpenBSD, NetBSD, DragonFly, MacOS, UWP, Android, Raspberry Pi, HTML5. - Audio loading and playing with streaming support (WAV, OGG, MP3, FLAC, XM, MOD)
* VR stereo rendering with configurable HMD device parameters - **VR stereo rendering** support with configurable HMD device parameters
* NO external dependencies, all required libraries included with raylib - Bindings to **Lua** ([raylib-lua](https://github.com/raysan5/raylib-lua)), **Go** ([raylib-go](https://github.com/gen2brain/raylib-go)) and more!.
* Complete bindings to LUA ([raylib-lua](https://github.com/raysan5/raylib-lua)) and Go ([raylib-go](https://github.com/gen2brain/raylib-go))
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. 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.
@ -42,7 +41,7 @@ raylib uses internally multiple single-file header-only libraries to support mul
*On Android, `native_app_glue module` (provided by Android NDK) and native Android libraries are used to manage window/context, inputs and activity life cycle.* *On Android, `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, Videocore API and EGL libraries are used for window/context management and raw inputs reading.* *On Raspberry Pi, `Videocore API` and `EGL` libraries are used for window/context management and raw inputs reading.*
build and installation build and installation
---------------------- ----------------------
@ -67,6 +66,7 @@ contact
* Reddit: [https://www.reddit.com/r/raylib](https://www.reddit.com/r/raylib) * Reddit: [https://www.reddit.com/r/raylib](https://www.reddit.com/r/raylib)
* Twitch: [http://www.twitch.tv/raysan5](http://www.twitch.tv/raysan5) * Twitch: [http://www.twitch.tv/raysan5](http://www.twitch.tv/raysan5)
* Patreon: [https://www.patreon.com/raylib](https://www.patreon.com/raylib) * Patreon: [https://www.patreon.com/raylib](https://www.patreon.com/raylib)
* Discord: [https://discord.gg/raylib](https://discord.gg/VkzNHUE)
* YouTube: [https://www.youtube.com/channel/raylib](https://www.youtube.com/channel/UC8WIBkhYb5sBNqXO1mZ7WSQ) * YouTube: [https://www.youtube.com/channel/raylib](https://www.youtube.com/channel/UC8WIBkhYb5sBNqXO1mZ7WSQ)
If you are using raylib and you enjoy it, please, [let me know][raysan5]. If you are using raylib and you enjoy it, please, [let me know][raysan5].

10
ROADMAP.md
View File

@ -6,11 +6,11 @@ Here it is a wish-list with features and ideas to improve the library.
Note that [raylib source code](https://github.com/raysan5/raylib/tree/master/src) has some *TODO* marks around code with pending things to review and improve. Check [GitHub Issues](https://github.com/raysan5/raylib/issues) for further details! Note that [raylib source code](https://github.com/raysan5/raylib/tree/master/src) has some *TODO* marks around code with pending things to review and improve. Check [GitHub Issues](https://github.com/raysan5/raylib/issues) for further details!
**raylib 1.x** **raylib 2.x**
- [ ] Basic GPU stats sytem (memory, draws, time...) - [ ] raynet: Network module
- [ ] Improved custom file-format (.rres) and packaging tool - [ ] Support Vulkan API (GRAPHICS_API_VULKAN)
- [ ] Touch-based camera controls for Android - [ ] Basic CPU/GPU stats sytem (memory, draws, time...)
- [ ] Quaternions-based camera system - [ ] Support Animated models
**raylib 1.8** **raylib 1.8**
- [x] Improved Materials system with PBR support - [x] Improved Materials system with PBR support