Documentation setup for release 1.2.3

cpctelera/docs/files/readme-txt.html

@@ -21,12 +21,12 @@
 
 <div class="CSection"><div class=CTopic><h2 class=CTitle><a name="Installing_CPCtelera"></a>Installing CPCtelera</h2><div class=CBody><p>CPCtelera works under Windows, Linux and OSX.&nbsp; It has been tested in Windows XP, 7 and 8, and in Ubuntu / Debian, Arch, Manjaro, Elementary OS and Raspbian Linux distributions.&nbsp; It works either on Intel architectures or on ARM&rsquo;s.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGeneric"><td class=SEntry><a href="#Downloading_CPCtelera" >Downloading CPCtelera</a></td><td class=SDescription>You can download CPCtelera from these sources</td></tr><tr class="SGeneric SMarked"><td class=SEntry><a href="#Software_Requirements" >Software Requirements</a></td><td class=SDescription>In order to install CPCtelera, your system will require previous software. </td></tr><tr class="SGeneric"><td class=SEntry><a href="#Installing_CPCtelera_in_your_system" >Installing CPCtelera in your system</a></td><td class=SDescription>These are the steps to install CPCtelera in your system</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
 
-<div class="CGeneric"><div class=CTopic><h3 class=CTitle><a name="Downloading_CPCtelera"></a>Downloading CPCtelera</h3><div class=CBody><p>You can download CPCtelera from these sources</p><ul><li>Download <a href="https://github.com/lronaldo/cpctelera/archive/v1.2.2.zip" class=LURL target=_top>current stable version 1.2.2</a></li><li>Get Latest version from github:</li></ul><blockquote><pre>git clone https://github.com/lronaldo/cpctelera</pre></blockquote></div></div></div>
+<div class="CGeneric"><div class=CTopic><h3 class=CTitle><a name="Downloading_CPCtelera"></a>Downloading CPCtelera</h3><div class=CBody><p>You can download CPCtelera from these sources</p><ul><li>Download <a href="https://github.com/lronaldo/cpctelera/archive/v1.2.3.zip" class=LURL target=_top>current stable version 1.2.3</a></li><li>Get Latest version from github:</li></ul><blockquote><pre>git clone https://github.com/lronaldo/cpctelera</pre></blockquote></div></div></div>
 
 <div class="CGeneric"><div class=CTopic><h3 class=CTitle><a name="Software_Requirements"></a>Software Requirements</h3><div class=CBody><p>In order to install CPCtelera, your system will require previous software.&nbsp; Check your system and install it before launching <b>setup.sh</b>.</p><h4 class=CHeading><u>Under Linux</u></h4><p>Install these packages on your Linux distribution.&nbsp; Although they are pretty standard, names may slightly vary on some distributions.</p><ul><li>Commands: <b>gcc</b>, <b>g++</b>, <b>make</b>, <b>bison</b>, <b>flex</b></li><li>Libraries: <b>libboost-dev</b>, <b>libfreeimage-dev</b></li></ul><h4 class=CHeading><u>Under Windows</u></h4><p>Under Windows <a href="http://www.cygwin.com" class=LURL target=_top>Cygwin</a> is required for CPCtelera to work.&nbsp; You may download Cygwin 32 / 64 and install it along with these packages (you may launch cygwin&rsquo;s setup.exe at any time to install them),</p><ul><li><b>gcc-core</b>, <b>gcc-g++</b>, <b>make</b>, <b>bison</b>, <b>flex</b></li><li><b>libboost-devel</b>, <b>libintl-devel</b></li></ul><h4 class=CHeading><u>Under OSX</u></h4><p>Under OSX <a href="https://itunes.apple.com/es/app/xcode/id497799835?mt=12" class=LURL target=_top>XCode</a>  and <a href="http://brew.sh/" class=LURL target=_top>Homebrew</a> are required for installing CPCtelera.&nbsp; Follow these steps,</p><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>1.</td><td class=CDLDescription>Install <a href="https://itunes.apple.com/es/app/xcode/id497799835?mt=12" class=LURL target=_top>XCode</a> if you didn&rsquo;t have it.</td></tr><tr><td class=CDLEntry>2.</td><td class=CDLDescription>Install <a href="http://brew.sh/" class=LURL target=_top>Homebrew</a> if you didn&rsquo;t have it.</td></tr><tr><td class=CDLEntry>3.</td><td class=CDLDescription>Open a terminal and install XCode Command Line tools with this command,</td></tr></table><blockquote><pre>xcode-select --install</pre></blockquote><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>4.</td><td class=CDLDescription>Install libboost and freeimage from homebrew with these commands,</td></tr></table><blockquote><pre>brew install boost
 brew install freeimage</pre></blockquote><p>Some things to take into account on OSX,</p><ul><li>Some previous OSX systems may not understand the xcode-select --install command.&nbsp; On those systems, there usually are menu options from the XCode GUI to install Command Line Tools.&nbsp; If you need more advice, there is a <a href="http://stackoverflow.com/questions/9329243/xcode-4-4-and-later-install-command-line-tools" class=LURL target=_top>nice explanation on stack overflow about the XCode Command Line Tools</a>.</li></ul></div></div></div>
 
-<div class="CGeneric"><div class=CTopic><h3 class=CTitle><a name="Installing_CPCtelera_in_your_system"></a>Installing CPCtelera in your system</h3><div class=CBody><p>These are the steps to install CPCtelera in your system</p><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>1.</td><td class=CDLDescription>Install required <a href="#Software_Requirements" class=LGeneric id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">Software Requirements</a></td></tr><tr><td class=CDLEntry>2.</td><td class=CDLDescription>Download and unzip <a href="https://github.com/lronaldo/cpctelera/archive/v1.2.2.zip" class=LURL target=_top>current stable version 1.2.2 of CPCtelera</a> (read &ldquo;some considerations&rdquo; below)</td></tr><tr><td class=CDLEntry>3.</td><td class=CDLDescription>Open a terminal an enter cpctelera/ folder.</td></tr></table><blockquote><pre>cd cpctelera/</pre></blockquote><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>4.</td><td class=CDLDescription>Launch <b>setup.sh</b></td></tr></table><blockquote><pre>./setup.sh</pre></blockquote><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>5.</td><td class=CDLDescription>Once <b>setup.sh</b> finishes, close your terminal and open a new one for changes to be set.</td></tr></table><p>CPCtelera is ready to be used in your system.</p><h4 class=CHeading>Some considerations</h4><ul><li>It is recommended to unzip CPCtelera to a folder inside your user&rsquo;s $HOME path (typically /home/username/ or C:\cygwin\home\username\).</li><li>Once you run <b>setup.sh</b>, CPCtelera will be installed in the path you have previously unzipped it.&nbsp; If you move the folder to a new location, you should run <b>setup.sh</b> again.</li><li>However, CPCTelera can be installed anywhere in your system, provided the path does not contain any spaces.</li><li><b>setup.sh</b> checks software dependencies.&nbsp; If some dependency is not met, you will receive an error message requesting you to install it and then launch <b>setup.sh</b> again.</li></ul></div></div></div>
+<div class="CGeneric"><div class=CTopic><h3 class=CTitle><a name="Installing_CPCtelera_in_your_system"></a>Installing CPCtelera in your system</h3><div class=CBody><p>These are the steps to install CPCtelera in your system</p><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>1.</td><td class=CDLDescription>Install required <a href="#Software_Requirements" class=LGeneric id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">Software Requirements</a></td></tr><tr><td class=CDLEntry>2.</td><td class=CDLDescription>Download and unzip <a href="https://github.com/lronaldo/cpctelera/archive/v1.2.3.zip" class=LURL target=_top>current stable version 1.2.3 of CPCtelera</a> (read &ldquo;some considerations&rdquo; below)</td></tr><tr><td class=CDLEntry>3.</td><td class=CDLDescription>Open a terminal an enter cpctelera/ folder.</td></tr></table><blockquote><pre>cd cpctelera/</pre></blockquote><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>4.</td><td class=CDLDescription>Launch <b>setup.sh</b></td></tr></table><blockquote><pre>./setup.sh</pre></blockquote><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>5.</td><td class=CDLDescription>Once <b>setup.sh</b> finishes, close your terminal and open a new one for changes to be set.</td></tr></table><p>CPCtelera is ready to be used in your system.</p><h4 class=CHeading>Some considerations</h4><ul><li>It is recommended to unzip CPCtelera to a folder inside your user&rsquo;s $HOME path (typically /home/username/ or C:\cygwin\home\username\).</li><li>Once you run <b>setup.sh</b>, CPCtelera will be installed in the path you have previously unzipped it.&nbsp; If you move the folder to a new location, you should run <b>setup.sh</b> again.</li><li>However, CPCTelera can be installed anywhere in your system, provided the path does not contain any spaces.</li><li><b>setup.sh</b> checks software dependencies.&nbsp; If some dependency is not met, you will receive an error message requesting you to install it and then launch <b>setup.sh</b> again.</li></ul></div></div></div>
 
 <div class="CSection"><div class=CTopic><h2 class=CTitle><a name="Starting_with_CPCtelera"></a>Starting with CPCtelera</h2><div class=CBody><p>Once <b>setup.sh</b> completes without errors, CPCtelera will be ready to use.&nbsp; To have a quick glance about what CPCtelera offers, you may enter examples/ folder and check all the examples included.&nbsp; You can build any one of them just by typing <b>make</b> inside the example folder, then CDT and DSK files will be automatically generated.</p><p>For creating your own projects, CPCtelera includes the <a href="commandline/cpct_mkproject-.html#cpct_mkproject" class=LFile id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">cpct_mkproject</a> command line tool.&nbsp; <b>setup.sh</b> configures your system&rsquo;s <b>$PATH</b> variable so that you have direct access to <a href="commandline/cpct_mkproject-.html#cpct_mkproject" class=LFile id=link7 onMouseOver="ShowTip(event, 'tt6', 'link7')" onMouseOut="HideTip('tt6')">cpct_mkproject</a> anywhere on your system (you should close and open your terminal again after setup.sh finishes).&nbsp; Creating a new project is as easy as typing this</p><blockquote><pre>cpct_mkproject [project_folder]</pre></blockquote><h4 class=CHeading>Once you have your own new project, you can enter its folder and you will have a Makefile and 2 important subfolders</h4><ul><li>src/ is the folder containing source files.&nbsp; At the start it only contains a main.c file, but you can create new files and folders (1 level of sub-folders) in it.&nbsp; All .c and .s files below src/ will be automatically detected and compiled when you type in &ldquo;make&rdquo; at your project folder.</li><li>cfg/ contains the building configuration of your project.&nbsp; In the file build_config.mk you will be able to make changes to the way the project is built.&nbsp; The 2 typical are changing the project name and its binary load address.&nbsp; Open the file and you will see 2 variables for this purpose.&nbsp; You can change them whenever you wanted.</li></ul><p>The rest is up to you.&nbsp; Navigate this reference manual, grasp code from examples and start your own projects.&nbsp; All of us are waiting to see your new games!&nbsp; :D</p></div></div></div>
 

cpctelera/docs/javascript/searchdata.js

@@ -1,5 +1,5 @@
 var indexSectionsWithContent = {
-   "Variables": {
+   "Macros": {
       "Symbols": false,
       "Numbers": false,
       "A": false,
@@ -29,16 +29,46 @@ var indexSectionsWithContent = {
       "Y": false,
       "Z": false
       },
-   "Macros": {
+   "General": {
+      "Symbols": false,
+      "Numbers": true,
+      "A": true,
+      "B": false,
+      "C": true,
+      "D": true,
+      "E": true,
+      "F": true,
+      "G": true,
+      "H": true,
+      "I": true,
+      "J": false,
+      "K": true,
+      "L": true,
+      "M": true,
+      "N": false,
+      "O": false,
+      "P": true,
+      "Q": false,
+      "R": true,
+      "S": true,
+      "T": true,
+      "U": true,
+      "V": true,
+      "W": true,
+      "X": false,
+      "Y": false,
+      "Z": false
+      },
+   "Constants": {
       "Symbols": false,
       "Numbers": false,
-      "A": false,
+      "A": true,
       "B": false,
       "C": true,
       "D": false,
       "E": false,
-      "F": false,
-      "G": false,
+      "F": true,
+      "G": true,
       "H": false,
       "I": false,
       "J": false,
@@ -47,37 +77,37 @@ var indexSectionsWithContent = {
       "M": false,
       "N": false,
       "O": false,
-      "P": false,
+      "P": true,
       "Q": false,
       "R": false,
       "S": false,
       "T": false,
       "U": false,
-      "V": false,
+      "V": true,
       "W": false,
       "X": false,
       "Y": false,
       "Z": false
       },
-   "Types": {
+   "Functions": {
       "Symbols": false,
       "Numbers": false,
-      "A": true,
+      "A": false,
       "B": false,
       "C": true,
       "D": false,
       "E": false,
-      "F": true,
+      "F": false,
       "G": false,
       "H": false,
-      "I": true,
+      "I": false,
       "J": false,
       "K": false,
-      "L": false,
+      "L": true,
       "M": false,
       "N": false,
       "O": false,
-      "P": false,
+      "P": true,
       "Q": false,
       "R": false,
       "S": false,
@@ -89,7 +119,7 @@ var indexSectionsWithContent = {
       "Y": false,
       "Z": false
       },
-   "Constants": {
+   "Types": {
       "Symbols": false,
       "Numbers": false,
       "A": true,
@@ -98,31 +128,31 @@ var indexSectionsWithContent = {
       "D": false,
       "E": false,
       "F": true,
-      "G": true,
+      "G": false,
       "H": false,
-      "I": false,
+      "I": true,
       "J": false,
       "K": false,
       "L": false,
       "M": false,
       "N": false,
       "O": false,
-      "P": true,
+      "P": false,
       "Q": false,
       "R": false,
       "S": false,
       "T": false,
-      "U": false,
-      "V": true,
+      "U": true,
+      "V": false,
       "W": false,
       "X": false,
       "Y": false,
       "Z": false
       },
-   "Files": {
+   "Variables": {
       "Symbols": false,
       "Numbers": false,
-      "A": true,
+      "A": false,
       "B": false,
       "C": true,
       "D": false,
@@ -143,46 +173,16 @@ var indexSectionsWithContent = {
       "S": false,
       "T": false,
       "U": false,
-      "V": true,
+      "V": false,
       "W": false,
       "X": false,
       "Y": false,
       "Z": false
       },
-   "General": {
-      "Symbols": false,
-      "Numbers": true,
-      "A": true,
-      "B": false,
-      "C": true,
-      "D": true,
-      "E": true,
-      "F": true,
-      "G": true,
-      "H": true,
-      "I": true,
-      "J": false,
-      "K": true,
-      "L": true,
-      "M": true,
-      "N": false,
-      "O": false,
-      "P": true,
-      "Q": false,
-      "R": true,
-      "S": true,
-      "T": true,
-      "U": true,
-      "V": true,
-      "W": true,
-      "X": false,
-      "Y": false,
-      "Z": false
-      },
-   "Functions": {
+   "Files": {
       "Symbols": false,
       "Numbers": false,
-      "A": false,
+      "A": true,
       "B": false,
       "C": true,
       "D": false,
@@ -193,17 +193,17 @@ var indexSectionsWithContent = {
       "I": false,
       "J": false,
       "K": false,
-      "L": true,
+      "L": false,
       "M": false,
       "N": false,
       "O": false,
-      "P": true,
+      "P": false,
       "Q": false,
       "R": false,
       "S": false,
       "T": false,
-      "U": true,
-      "V": false,
+      "U": false,
+      "V": true,
       "W": false,
       "X": false,
       "Y": false,