From f526dd374cbcb3371c34414b530334d022a3cc7c Mon Sep 17 00:00:00 2001 From: Ray Date: Tue, 7 Jun 2016 17:51:33 +0200 Subject: [PATCH] Updated Default Paths (markdown) --- Default-Paths.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/Default-Paths.md b/Default-Paths.md index 5ed30ff..ca01599 100644 --- a/Default-Paths.md +++ b/Default-Paths.md @@ -1,11 +1,20 @@ -Like any other library or compilation system, a raylib project requires the different elements placed correctly. +Like any other library or project, a raylib project requires different [dependencies](https://github.com/raysan5/raylib/wiki/External-dependencies) placed accordingly for a correct compilation. It means external library headers and, eventually, some static library. -Notepad++ comes with a bunch of scripts ready for compiling a raylib project for different platforms. Those scripts assume that raylib is installed in the portable folder path: C:\raylib +Dependencies depend on platform, so every platform requires some libraries installed in an specific folder to be accesible for the compiler when compiling raylib or a raylib example/game. -In some cases, it could be that user decided to move that folder; in that case raylib paths need to be reconfigured. +Specific dependencies installation is listed for every platform on this [Wiki](https://github.com/raysan5/raylib/wiki). Actually, there are not many external dependencies for raylib, only a couple (GLFW3, OpenAL Soft) and only in some platforms. -Check scripts, usually default path is set at begginning of the script. +## Dependencies on Windows + +For Windows platform, raylib is distributed with a self-contained installer that includes, not only raylib but also a raylib-ready-configured free text editor ([Notepad++](https://notepad-plus-plus.org/)) and a C/C++ compiler with tools ([MinGW](http://www.mingw.org/)). + +Notepad++ comes with a bunch of pre-created scripts ready for compiling a raylib project and raylib source for different platforms. Those scripts assume that raylib is installed in the portable folder path: `C:\raylib` + +In some cases, it could happen that user decided to move that folder to somewhere else; in that case, raylib paths need to be reconfigured, just updating the `RAYLIB_PATH` variable **at the beginning of every script**. + +As a recommendation, if you move `C:\raylib` folder to somewhere else, try to avoid spaces and special characters on the new path, it could generate errors on compilation. + +For command-line compilation and custom pipeline configuration, just check [Compile for Windows](https://github.com/raysan5/raylib/wiki/Compile-for-Windows) wiki. -- TODO: Complete documentation... - \ No newline at end of file