From 4007b45af116bf5c69bb5c2847f2af8314ee5bdc Mon Sep 17 00:00:00 2001 From: Crayon2000 Date: Sat, 25 Feb 2017 13:16:08 -0500 Subject: [PATCH] Add licence to Related Pages in documentation The licence file extension was changed to Markdown. --- .travis.yml | 10 ++++++---- GRRLIB/GRRLIB/grrlib.h | 25 +------------------------ LICENCE.TXT => LICENCE.md | 0 README.md | 10 +++++----- grrlib.doxygen | 6 ++++-- 5 files changed, 16 insertions(+), 35 deletions(-) rename LICENCE.TXT => LICENCE.md (100%) diff --git a/.travis.yml b/.travis.yml index d0cbccd..20dc47c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,6 @@ language: c +dist: trusty +sudo: required os: - linux @@ -9,12 +11,12 @@ env: - DEVKITPPC=${DEVKITPRO}/devkitPPC before_install: - - wget http://sourceforge.net/projects/devkitpro/files/Automated%20Installer/devkitPPCupdate.pl + - wget https://sourceforge.net/projects/devkitpro/files/Automated%20Installer/devkitPPCupdate.pl install: - sudo perl devkitPPCupdate.pl script: - - cd GRRLIB && sudo -E make clean all install && cd .. - - cd examples && make && cd .. - - cd GRRLIB && sudo -E make PLATFORM=cube clean all && cd .. + - (cd GRRLIB && sudo -E make clean all install) + - (cd examples && make) + - (cd GRRLIB && sudo -E make PLATFORM=cube clean all) diff --git a/GRRLIB/GRRLIB/grrlib.h b/GRRLIB/GRRLIB/grrlib.h index 4ca2b65..037129c 100644 --- a/GRRLIB/GRRLIB/grrlib.h +++ b/GRRLIB/GRRLIB/grrlib.h @@ -226,28 +226,5 @@ GRR_EXTERN u32 fb GRR_INIT(0); * Advisors : RedShade, Jespa\n * * @section Licence - * Copyright (c) 2009-2017 The GRRLIB Team - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN - * THE SOFTWARE. - * - * @example template/source/main.c - * This example shows the minimum code required to use GRRLIB. - * It could be used as a template to start a new project. - * More elaborate examples can be found inside the \e examples folder. + * See the [LICENCE](LICENCE.md) file for licence rights and limitations (MIT). */ diff --git a/LICENCE.TXT b/LICENCE.md similarity index 100% rename from LICENCE.TXT rename to LICENCE.md diff --git a/README.md b/README.md index 2d2c05b..2745fc5 100644 --- a/README.md +++ b/README.md @@ -164,13 +164,13 @@ Using GRRLIB After everything is installed, simply put ```c - #include +#include ``` at the top of your .c/.cpp file and use the functions as required You will also need to add ```make - -lgrrlib -lfreetype -lfat -ljpeg -lpngu -lpng -lz +-lgrrlib -lfreetype -lfat -ljpeg -lpngu -lpng -lz ``` to the libs line in your makefile @@ -190,12 +190,12 @@ Upgrading to v4.1.0 From Previous Versions of GRRLIB Older versions of GRRLIB, required a line such as: ```c - #include "../../../GRRLIB/GRRLIB/GRRLIB.h" +#include "../../../GRRLIB/GRRLIB/GRRLIB.h" ``` ...to be placed at the top of each C file which uses GRRLB. Because GRRLIB is now installed as a system library, this must be replaced with: ```c - #include +#include ``` Older versions of GRRLIB required the 'GRRLIB.h' and 'GRRLIB.c" files to be @@ -272,7 +272,7 @@ Credits Licence ------- -GRRLIB is released under the [MIT Licence](https://github.com/GRRLIB/GRRLIB/blob/master/LICENCE.TXT). +GRRLIB is released under the [MIT Licence](LICENCE.md). If we had chosen the GPL licence you would be +forced+ (legally required) to release your source code. But in the spirit of "free as in FREE" we have left you with the +option+ to release your source code. diff --git a/grrlib.doxygen b/grrlib.doxygen index 5e672f9..5c21337 100644 --- a/grrlib.doxygen +++ b/grrlib.doxygen @@ -791,7 +791,8 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = ./GRRLIB/GRRLIB \ - ./GRRLIB/GRRLIB/grrlib + ./GRRLIB/GRRLIB/grrlib \ + LICENCE.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -818,7 +819,8 @@ INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.c \ *.cpp \ - *.h + *.h \ + *.md # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well.