Add license information in the About section : GPL v3

+ header on each source file
+ license information for each library or ressource used
+ credits
Fixes #45

css/app.css

@@ -1,5 +1,24 @@
-/* Main CSS of the application */
-
+/*!
+ * app.css : Main CSS of the application
+ * 
+ * Copyright 2013 Mossroy
+ * License GPL v3:
+ * 
+ * This file is part of Evopedia.
+ * 
+ * Evopedia is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Evopedia is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Evopedia (file LICENSE-GPLv3.txt).  If not, see <http://www.gnu.org/licenses/>
+ */
 
 [role=region] {
   top: 0; right: 0; bottom: 0; left: 0;

index.html

@@ -7,28 +7,29 @@
         <meta name="description" content="Offline wikipedia reader"> 
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
         <!--
-        Port of Evopedia (offline wikipedia reader) in HTML5/Javascript, with Firefox OS as the primary target
-        The original application is at http://www.evopedia.info/
-        It uses wikipedia dumps located at http://dumpathome.evopedia.info/dumps/finished
-        
-        Author : Mossroy - [email protected]
+        Evopedia (offline wikipedia reader) - HTML5/Javascript version
+        Home page : http://www.evopedia.info/
+                
+        Main author of this application : Mossroy - [email protected]
         Math image algorithm contributed by [email protected]
+
+        Copyright 2013 Mossroy
+        License GPL v3:
         
-        License:
-        
-            This program is free software; you can redistribute it and/or modify it
-            under the terms of the GNU General Public License as published by the
-            Free Software Foundation; either version 3 of the License, or (at your
-            option) any later version.
-        
-            This program is distributed in the hope that it will be useful, but
-            WITHOUT ANY WARRANTY; without even the implied warranty of
-            MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-            General Public License for more details.
-        
-            You should have received a copy of the GNU General Public
-            License along with this program; if not, see
-            <http://www.gnu.org/licenses/>.
+        This file is part of Evopedia.
+
+        Evopedia is free software: you can redistribute it and/or modify
+        it under the terms of the GNU General Public License as published by
+        the Free Software Foundation, either version 3 of the License, or
+        (at your option) any later version.
+
+        Evopedia is distributed in the hope that it will be useful,
+        but WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+        GNU General Public License for more details.
+
+        You should have received a copy of the GNU General Public License
+        along with Evopedia (file LICENSE-GPLv3.txt).  If not, see <http://www.gnu.org/licenses/>
         
         -->
 
@@ -84,6 +85,7 @@ <h2>About</h2>
                     The original application (developed in Qt) is at <a href="http://www.evopedia.info/" target="_blank">http://www.evopedia.info/</a>
                     <br />
                     <br />
+                    <h3>Usage</h3>
                     To use it, you have to first download locally an archive from <a href="http://dumpathome.evopedia.info/dumps/finished" target="_blank">http://dumpathome.evopedia.info/dumps/finished</a>, from a regular computer.
                     <br />If you get a compressed archive (.zip, .tar.gz or .tar.bz2), you will have to decompress it.
                     <br />For a quick test, you can start with the dump called <a href="http://evopedia.info/dumps/wikipedia_small_2010-08-14.tar.gz" target="_blank">"small"</a> : it can be downloaded through HTTP and contains a very small subset of the English archive (note that the hyperlinks between articles will rarely work, as a lot of articles are missing in it).
@@ -97,6 +99,7 @@ <h2>About</h2>
                         <li>On Android, it does not seem to work for now (tried with internal browser, Chrome and Firefox) because you can not select all the files of an archive</li>
                     </ul>
                     <br />
+                    <h3>Feedback</h3>
                     It's still a beta version : there are many ways this could be enhanced (suggestions and patches are welcome : the source code is on <a href="https://github.com/mossroy/evopedia-html5" target="_blank">github</a>). In particular :
                     <ul>
                         <li>It is not easy to use on the Peak device from Geeksphone because the buttons and inputs are too small</li>
@@ -105,6 +108,42 @@ <h2>About</h2>
                     The <a href="https://github.com/mossroy/evopedia-html5/issues" target="_blank">bugtracker</a> is on github too. I use it as my roadmap.
                     <br />Alternatively, you can send your feedback <a href="mailto:[email protected]?subject=Feedback%20about%20Evopedia%20HTML5">by email</a>.
                     <br />In all cases, please give me as much detail as you can : which device or browser you are using, which archive, which articles etc.
+                    <br />
+                    <br />
+                    <h3>Credits</h3>
+                    Many thanks to [email protected], leader of the Evopedia project. He originally developed the Qt application, designed the archive format, and organizes the updates of these archives
+                    <br />Christian also contributed some code on this application, for the math images.
+                    <br />Thank you mapilette for testing and supporting
+                    <br />
+                    <h3>License</h3>
+                    This application is licensed under the GPL v3 license :
+                    <br />
+                    <i>
+                    <br />Evopedia is free software: you can redistribute it and/or modify
+                    <br />it under the terms of the GNU General Public License as published by
+                    <br />the Free Software Foundation, either version 3 of the License, or
+                    <br />(at your option) any later version.
+                    <br /> 
+                    <br />Evopedia is distributed in the hope that it will be useful,
+                    <br />but WITHOUT ANY WARRANTY; without even the implied warranty of
+                    <br />MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+                    <br />GNU General Public License for more details.
+                    <br />
+                    <br />You should have received a copy of the GNU General Public License
+                    <br />along with Evopedia (file LICENSE-GPLv3.txt).  If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>
+                    </i>
+                    <br />
+                    <br /> Main libraries and ressources used :
+                    <ul>
+                        <li><a href="http://jquery.com/">jQuery</a> 2, released under the <a href="http://jquery.org/license">MIT license</a></li>
+                        <li><a href="http://getbootstrap.com/">Bootstrap</a> 3, released under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache license 2.0</a>, which includes icons from <a href="http://glyphicons.com/">Glyphicons</a></li>
+                        <li><a href="https://github.com/antimatter15/bzip2.js">bzip2.js</a>, released under the <a href="http://www.gnu.org/copyleft/lgpl.html">LGPL v2 license</a></li>
+                        <li><a href="http://www.requirejs.org/">RequireJS</a> 2, released under the <a href="https://github.com/jrburke/requirejs/blob/master/LICENSE">MIT license or new BSD license</a></li>
+                        <li><a href="http://zeptojs.com/">ZeptoJS</a> 2, released under the <a href="https://github.com/madrobby/zepto/blob/master/MIT-LICENSE">MIT license</a></li>
+                        <li><a href="http://qunitjs.com/">QUnit</a> 2, released under the <a href="http://jquery.org/license">MIT license</a></li>
+                        <li>Icon, algorithms and inspiration from <a href="https://github.com/evopedia/evopedia_qt/">Evopedia (Qt version)</a>, released under the <a href="https://www.gnu.org/licenses/">GPL v3 license</a></li>
+                        <li>Mediawiki CSS from <a href="http://wikidev.net/">Wikidev</a>, released under the <a href="http://www.gnu.org/copyleft/gpl.html">GPL license</a></li>
+                    </ul>
                 </div>
 
                 <div id="configuration" style="display: none;">

js/app.js

@@ -1,3 +1,25 @@
+/**
+ * app.js : User Interface implementation
+ * This file handles the interaction between the application and the user
+ * 
+ * Copyright 2013 Mossroy
+ * License GPL v3:
+ * 
+ * This file is part of Evopedia.
+ * 
+ * Evopedia is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Evopedia is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Evopedia (file LICENSE-GPLv3.txt).  If not, see <http://www.gnu.org/licenses/>
+ */
 
 // This uses require.js to structure javascript:
 // http://requirejs.org/docs/api.html#define

js/init.js

@@ -1,3 +1,25 @@
+/**
+ * init.js : Configuration for the library require.js
+ * This file handles the dependencies between javascript libraries
+ * 
+ * Copyright 2013 Mossroy
+ * License GPL v3:
+ * 
+ * This file is part of Evopedia.
+ * 
+ * Evopedia is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Evopedia is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Evopedia (file LICENSE-GPLv3.txt).  If not, see <http://www.gnu.org/licenses/>
+ */
 require.config({
     baseUrl: 'js/lib',
     paths: {

js/lib/archive.js

@@ -1,5 +1,24 @@
-/* 
- * Class for a local Evopedia archive, with the algorithms to read it
+/**
+ * archive.js : Class for a local Evopedia archive, with the algorithms to read it
+ * This file handles finding a title in an archive, reading an article in an archive etc
+ * 
+ * Copyright 2013 Mossroy
+ * License GPL v3:
+ * 
+ * This file is part of Evopedia.
+ * 
+ * Evopedia is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Evopedia is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Evopedia (file LICENSE-GPLv3.txt).  If not, see <http://www.gnu.org/licenses/>
  */
 define(function(require) {
 

js/lib/normalize_string.js

@@ -1,3 +1,25 @@
+/**
+ * normalize_string.js : Normalize a string in the same way the titles are normalized in an archive
+ * This is necessary to search for titles in an archive
+ * 
+ * Copyright 2013 Mossroy
+ * License GPL v3:
+ * 
+ * This file is part of Evopedia.
+ * 
+ * Evopedia is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Evopedia is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Evopedia (file LICENSE-GPLv3.txt).  If not, see <http://www.gnu.org/licenses/>
+ */
 define(function(require) {
 
     // Algorithm copied from original application :

js/lib/title.js

@@ -1,5 +1,23 @@
-/* 
- * Class for the title of an article
+/**
+ * title.js : Class for the title of an article
+ * 
+ * Copyright 2013 Mossroy
+ * License GPL v3:
+ * 
+ * This file is part of Evopedia.
+ * 
+ * Evopedia is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Evopedia is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Evopedia (file LICENSE-GPLv3.txt).  If not, see <http://www.gnu.org/licenses/>
  */
 define(function(require) {
 

js/lib/utf8.js

@@ -1,3 +1,26 @@
+/**
+ * utf8.js : UTF8 conversion functions
+ * Original code from http://stackoverflow.com/users/553542/kadm , taken from
+ * http://stackoverflow.com/questions/1240408/reading-bytes-from-a-javascript-string
+ * 
+ * Copyright 2013 Mossroy
+ * License GPL v3:
+ * 
+ * This file is part of Evopedia.
+ * 
+ * Evopedia is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Evopedia is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Evopedia (file LICENSE-GPLv3.txt).  If not, see <http://www.gnu.org/licenses/>
+ */
 define(function(require) {
 
     var utf8 = {};

js/lib/util.js

@@ -1,5 +1,23 @@
-/* 
- * Utility functions
+/**
+ * util.js : Utility functions
+ * 
+ * Copyright 2013 Mossroy
+ * License GPL v3:
+ * 
+ * This file is part of Evopedia.
+ * 
+ * Evopedia is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Evopedia is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Evopedia (file LICENSE-GPLv3.txt).  If not, see <http://www.gnu.org/licenses/>
  */
 define(function(require) {
 
@@ -51,6 +69,7 @@ define(function(require) {
 
     /**
      * Convert a Uint8Array to base64
+     * TODO : might be replaced by btoa() built-in function? https://developer.mozilla.org/en-US/docs/Web/API/window.btoa
      * @param {type} byteArray
      * @returns {String}
      */

js/lib/webworker_bzip2.js

@@ -1,5 +1,23 @@
 /**
- * WebWorker implementation, in order to run bzip2 decompression in the background
+ * webworker_bzip2.js : WebWorker implementation, in order to run bzip2 decompression in the background
+ * 
+ * Copyright 2013 Mossroy
+ * License GPL v3:
+ * 
+ * This file is part of Evopedia.
+ * 
+ * Evopedia is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Evopedia is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Evopedia (file LICENSE-GPLv3.txt).  If not, see <http://www.gnu.org/licenses/>
  */
 importScripts('./require.js');
 

tests.html

@@ -3,6 +3,26 @@
     <head>
         <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
         <title>Evopedia HTML5 Unit tests</title>
+
+        <!--
+        Copyright 2013 Mossroy
+        License GPL v3:
+        
+        This file is part of Evopedia.
+
+        Evopedia is free software: you can redistribute it and/or modify
+        it under the terms of the GNU General Public License as published by
+        the Free Software Foundation, either version 3 of the License, or
+        (at your option) any later version.
+
+        Evopedia is distributed in the hope that it will be useful,
+        but WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+        GNU General Public License for more details.
+
+        You should have received a copy of the GNU General Public License
+        along with Evopedia (file LICENSE-GPLv3.txt).  If not, see <http://www.gnu.org/licenses/>
+        -->
 
         <link rel="stylesheet" href="tests/qunit-1.11.0.css" />
         <script src="tests/qunit-1.11.0.js"></script>