From 3521193bbf388bdfe090dea00345e505890a9b85 Mon Sep 17 00:00:00 2001 From: Ray Date: Mon, 18 Nov 2013 23:58:36 +0100 Subject: Updated text files to support markup --- CHANGELOG | 17 --------- CHANGELOG.md | 17 +++++++++ HELPME | 39 -------------------- HELPME.md | 39 ++++++++++++++++++++ LICENSE | 30 ---------------- LICENSE.md | 30 ++++++++++++++++ README | 115 ----------------------------------------------------------- README.md | 115 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ROADMAP | 22 ------------ ROADMAP.md | 22 ++++++++++++ 10 files changed, 223 insertions(+), 223 deletions(-) delete mode 100644 CHANGELOG create mode 100644 CHANGELOG.md delete mode 100644 HELPME create mode 100644 HELPME.md delete mode 100644 LICENSE create mode 100644 LICENSE.md delete mode 100644 README create mode 100644 README.md delete mode 100644 ROADMAP create mode 100644 ROADMAP.md diff --git a/CHANGELOG b/CHANGELOG deleted file mode 100644 index dc47ee53..00000000 --- a/CHANGELOG +++ /dev/null @@ -1,17 +0,0 @@ -changelog ---------- - -Current: raylib 1.0 (November 2013) - - -------------------------------------------- -Release: raylib 1.0.0 (18 November 2013) -------------------------------------------- -* Initial version -* 6 Modules provided: - - core: basic window/context creation functions, input management, timming functions - - shapes: basic shapes drawing functions - - textures: image data loading and conversion to OpenGL textures - - text: text drawing, sprite fonts loading, default font loading - - models: basic 3d shapes drawing, OBJ models loading and drawing - - audio: audio device initialization, WAV files loading and playing \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..dc47ee53 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ +changelog +--------- + +Current: raylib 1.0 (November 2013) + + +------------------------------------------- +Release: raylib 1.0.0 (18 November 2013) +------------------------------------------- +* Initial version +* 6 Modules provided: + - core: basic window/context creation functions, input management, timming functions + - shapes: basic shapes drawing functions + - textures: image data loading and conversion to OpenGL textures + - text: text drawing, sprite fonts loading, default font loading + - models: basic 3d shapes drawing, OBJ models loading and drawing + - audio: audio device initialization, WAV files loading and playing \ No newline at end of file diff --git a/HELPME b/HELPME deleted file mode 100644 index 98d1c7b3..00000000 --- a/HELPME +++ /dev/null @@ -1,39 +0,0 @@ -help me! -======== - -I’m working hard on raylib but my resources are quite limited. If you enjoy raylib and want to help / contribute in some way, -please, [let me know][raysan5]. - -The following help is highly appreciated: - - - C programming - Can you write / review / test / improve the code? - - Translators / Localizators - Can you translate raylib to another language? - - Documentation / Tutorials / Example writters - Can you write some tutorial / example? - - Web Development (I need a lot of help with this...) - Can you help with the web? - - Porting to Linux and OSX - Can you compile and test raylib on another OS? - - Testers of current features and multiple systems - Can you find some bug on raylib? - -If you can not help on any of the above points but you still want to contribute in some way... please, consider helping -with a small donation (just some euros...). It will really motivate to continue improving this project (and pay some bills… or some coffee). - -[Donation Page] (www.raylib.com/helpme.htm) - -raylib philosophy ------------------- - - * raylib is a tool to LEARN videogames programming, every single function in raylib should be a tutorial on itself. - * raylib is SIMPLE and EASY-TO-USE, I tried to keep it compact with a small set of functions, if a function is too complex or - has not a clear usefulness, better not to include it. - * raylib is open source and free; educators and institutions can use this tool to TEACH videogames programming completely by free. - * raylib is, hopefully, collaborative; contribution of tutorials / code-examples / bugs-solving / code-comments are highly appreciated. - * raylib's license (and its external libs respective licenses) allow using it for commercial products. - -contact -------- - - * Webpage: [http://www.raylib.com](http://www.raylib.com) - * Twitter: [http://www.twitter.com/raysan5](http://www.twitter.com/raysan5) - * Facebook: [http://www.facebook.com/raylibgames](http://www.facebook.com/raylibgames) - - -[raysan5]: mailto:raysan@raysanweb.com "Ramon Santamaria - Ray San" \ No newline at end of file diff --git a/HELPME.md b/HELPME.md new file mode 100644 index 00000000..98d1c7b3 --- /dev/null +++ b/HELPME.md @@ -0,0 +1,39 @@ +help me! +======== + +I’m working hard on raylib but my resources are quite limited. If you enjoy raylib and want to help / contribute in some way, +please, [let me know][raysan5]. + +The following help is highly appreciated: + + - C programming - Can you write / review / test / improve the code? + - Translators / Localizators - Can you translate raylib to another language? + - Documentation / Tutorials / Example writters - Can you write some tutorial / example? + - Web Development (I need a lot of help with this...) - Can you help with the web? + - Porting to Linux and OSX - Can you compile and test raylib on another OS? + - Testers of current features and multiple systems - Can you find some bug on raylib? + +If you can not help on any of the above points but you still want to contribute in some way... please, consider helping +with a small donation (just some euros...). It will really motivate to continue improving this project (and pay some bills… or some coffee). + +[Donation Page] (www.raylib.com/helpme.htm) + +raylib philosophy +------------------ + + * raylib is a tool to LEARN videogames programming, every single function in raylib should be a tutorial on itself. + * raylib is SIMPLE and EASY-TO-USE, I tried to keep it compact with a small set of functions, if a function is too complex or + has not a clear usefulness, better not to include it. + * raylib is open source and free; educators and institutions can use this tool to TEACH videogames programming completely by free. + * raylib is, hopefully, collaborative; contribution of tutorials / code-examples / bugs-solving / code-comments are highly appreciated. + * raylib's license (and its external libs respective licenses) allow using it for commercial products. + +contact +------- + + * Webpage: [http://www.raylib.com](http://www.raylib.com) + * Twitter: [http://www.twitter.com/raysan5](http://www.twitter.com/raysan5) + * Facebook: [http://www.facebook.com/raylibgames](http://www.facebook.com/raylibgames) + + +[raysan5]: mailto:raysan@raysanweb.com "Ramon Santamaria - Ray San" \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 2b608cec..00000000 --- a/LICENSE +++ /dev/null @@ -1,30 +0,0 @@ -license -======= - -source code ------------ - -raylib is licensed under an unmodified zlib/libpng license, which is an OSI-certified, -BSD-like license that allows static linking with closed source software: - -Copyright (c) 2013 Ramon Santamaria (Ray San - raysan@raysanweb.com) - -This software is provided "as-is", without any express or implied warranty. In no event -will the authors be held liable for any damages arising from the use of this software. - -Permission is granted to anyone to use this software for any purpose, including commercial -applications, and to alter it and redistribute it freely, subject to the following restrictions: - - 1. The origin of this software must not be misrepresented; you must not claim that you - wrote the original software. If you use this software in a product, an acknowledgment - in the product documentation would be appreciated but is not required. - - 2. Altered source versions must be plainly marked as such, and must not be misrepresented - as being the original software. - - 3. This notice may not be removed or altered from any source distribution. - -fonts ------- - -...soon... \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..2b608cec --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,30 @@ +license +======= + +source code +----------- + +raylib is licensed under an unmodified zlib/libpng license, which is an OSI-certified, +BSD-like license that allows static linking with closed source software: + +Copyright (c) 2013 Ramon Santamaria (Ray San - raysan@raysanweb.com) + +This software is provided "as-is", without any express or implied warranty. In no event +will the authors be held liable for any damages arising from the use of this software. + +Permission is granted to anyone to use this software for any purpose, including commercial +applications, and to alter it and redistribute it freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not claim that you + wrote the original software. If you use this software in a product, an acknowledgment + in the product documentation would be appreciated but is not required. + + 2. Altered source versions must be plainly marked as such, and must not be misrepresented + as being the original software. + + 3. This notice may not be removed or altered from any source distribution. + +fonts +------ + +...soon... \ No newline at end of file diff --git a/README b/README deleted file mode 100644 index 62527e27..00000000 --- a/README +++ /dev/null @@ -1,115 +0,0 @@ - - - -raylib -======= - -about ------ - -raylib is a simple and easy-to-use library to learn C videogames programming. - -raylib is highly inspired by Borland BGI graphics lib (more specifically WinBGI) and by XNA framework. -Allegro and SDL have also been analyzed for reference. - -Want to see how easy is making games with raylib? Jump to [code examples!] (http://www.raylib.com/examples.htm) - -history -------- - -I've developed videogames for some years and last year I had to taught videogames development -to young people with artistic profile, most of them had never written a single line of code. - -I started with C language basis and, after searching for the most simple and easy-to-use library to teach -videogames programming, I found WinBGI; it was great and it worked very well with students, in just a -couple of weeks that people that had never written a single line of code were able to program (and understand) -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. - -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), -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 started as a weekend project and after three months of hard work, here it is the first version. - -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 - -raylib uses on its core module the outstanding [GLFW3] (http://glfw.org/) library. The best option by far I found for -window/context and input management (clean, focused, great license, well documented, modern, ...). - -raylib is licensed under a zlib/libpng license like GLFW3. View [LICENSE] (link to license file). - -tool requirements ------------------- - -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/) - -Those are the tools I recommended to develop with raylib, actually, my students develop using this tools. -I believe those are the best tools to train spartan-programmers. - -Someone could argue about debugging. raylib is a library intended for learning and I think C it's a clear enough language -to allow writing small-mid size programs with a printf-based debugging. All raylib examples have also been written this way. - -building --------- - -raylib could be build with the following command lines (Using GCC compiler): - - cd raylib/src - 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 audio.c -std=c99 -Wall - ar rcs raylib.a core.o shapes.o textures.o stb_image.o text.o models.o vector3.o audio.o - -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. - - cd raylib/src/examples - gcc -o test_code.exe test_code.c icon.o -lraylib -lglfw3 -lopengl32 -lgdi32 -std=c99 -Wl,--subsystem,windows - -contact -------- - - * Webpage: [http://www.raylib.com](http://www.raylib.com) - * Twitter: [http://www.twitter.com/raysan5](http://www.twitter.com/raysan5) - * Facebook: [http://www.facebook.com/raylibgames](http://www.facebook.com/raylibgames) - -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.htm) - -acknowledgments ---------------- - -The following people have contributed in some way to make raylib project a reality. Big thanks to them! - - - Zopokx - - Elendow - - -[raysan5]: mailto:raysan@raysanweb.com "Ramon Santamaria - Ray San" \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..62527e27 --- /dev/null +++ b/README.md @@ -0,0 +1,115 @@ + + + +raylib +======= + +about +----- + +raylib is a simple and easy-to-use library to learn C videogames programming. + +raylib is highly inspired by Borland BGI graphics lib (more specifically WinBGI) and by XNA framework. +Allegro and SDL have also been analyzed for reference. + +Want to see how easy is making games with raylib? Jump to [code examples!] (http://www.raylib.com/examples.htm) + +history +------- + +I've developed videogames for some years and last year I had to taught videogames development +to young people with artistic profile, most of them had never written a single line of code. + +I started with C language basis and, after searching for the most simple and easy-to-use library to teach +videogames programming, I found WinBGI; it was great and it worked very well with students, in just a +couple of weeks that people that had never written a single line of code were able to program (and understand) +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. + +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), +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 started as a weekend project and after three months of hard work, here it is the first version. + +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 + +raylib uses on its core module the outstanding [GLFW3] (http://glfw.org/) library. The best option by far I found for +window/context and input management (clean, focused, great license, well documented, modern, ...). + +raylib is licensed under a zlib/libpng license like GLFW3. View [LICENSE] (link to license file). + +tool requirements +------------------ + +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/) + +Those are the tools I recommended to develop with raylib, actually, my students develop using this tools. +I believe those are the best tools to train spartan-programmers. + +Someone could argue about debugging. raylib is a library intended for learning and I think C it's a clear enough language +to allow writing small-mid size programs with a printf-based debugging. All raylib examples have also been written this way. + +building +-------- + +raylib could be build with the following command lines (Using GCC compiler): + + cd raylib/src + 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 audio.c -std=c99 -Wall + ar rcs raylib.a core.o shapes.o textures.o stb_image.o text.o models.o vector3.o audio.o + +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. + + cd raylib/src/examples + gcc -o test_code.exe test_code.c icon.o -lraylib -lglfw3 -lopengl32 -lgdi32 -std=c99 -Wl,--subsystem,windows + +contact +------- + + * Webpage: [http://www.raylib.com](http://www.raylib.com) + * Twitter: [http://www.twitter.com/raysan5](http://www.twitter.com/raysan5) + * Facebook: [http://www.facebook.com/raylibgames](http://www.facebook.com/raylibgames) + +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.htm) + +acknowledgments +--------------- + +The following people have contributed in some way to make raylib project a reality. Big thanks to them! + + - Zopokx + - Elendow + + +[raysan5]: mailto:raysan@raysanweb.com "Ramon Santamaria - Ray San" \ No newline at end of file diff --git a/ROADMAP b/ROADMAP deleted file mode 100644 index dc22e564..00000000 --- a/ROADMAP +++ /dev/null @@ -1,22 +0,0 @@ -roadmap -======= - -First version of raylib is quite complete and functional but there is still a lot of things I would like to improve. -Here it is a list of features I would like to add and functions to improve. - -Around the source code there are some TODO points with pending revisions/bugs and ere it is a list of features I would like to add. - -raylib v1.x - - - Review Billboard Drawing functions - - Review Heightmap Loading and Drawing functions - - Lighting support (only 3d mode) - CreateLight() - - Simple Collision Detection functions - CheckCollisionRects(), CheckCollisionCircles() - - Default scene Camera controls (zoom, pan, rotate) - - Basic Procedural Texture / Image generation (Gradient, Checked, Spot, Noise, Cellular) - - Software mipmapping generation and POT conversion (custom implementation) - - Comments / Functions translation (?) - -Any feature missing? Do you have a request? [Let me know!][raysan5] - -[raysan5]: mailto:raysan@raysanweb.com "Ramon Santamaria - Ray San" \ No newline at end of file diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 00000000..dc22e564 --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,22 @@ +roadmap +======= + +First version of raylib is quite complete and functional but there is still a lot of things I would like to improve. +Here it is a list of features I would like to add and functions to improve. + +Around the source code there are some TODO points with pending revisions/bugs and ere it is a list of features I would like to add. + +raylib v1.x + + - Review Billboard Drawing functions + - Review Heightmap Loading and Drawing functions + - Lighting support (only 3d mode) - CreateLight() + - Simple Collision Detection functions - CheckCollisionRects(), CheckCollisionCircles() + - Default scene Camera controls (zoom, pan, rotate) + - Basic Procedural Texture / Image generation (Gradient, Checked, Spot, Noise, Cellular) + - Software mipmapping generation and POT conversion (custom implementation) + - Comments / Functions translation (?) + +Any feature missing? Do you have a request? [Let me know!][raysan5] + +[raysan5]: mailto:raysan@raysanweb.com "Ramon Santamaria - Ray San" \ No newline at end of file -- cgit v1.2.3