From ed9c2eebad58cec2dbae6d8e77f84a38b8ddc5ea Mon Sep 17 00:00:00 2001 From: Tobias Bieniek Date: Sat, 9 Mar 2013 18:47:53 +0100 Subject: [PATCH 1/6] Renamed authors.txt, license.txt and readme.md to uppercase variants This sets the text files apart from the rest of the code files and seems to be the standard for most projects --- authors.txt => AUTHORS.txt | 0 license.txt => LICENSE.txt | 0 readme.md => README.md | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename authors.txt => AUTHORS.txt (100%) rename license.txt => LICENSE.txt (100%) rename readme.md => README.md (100%) diff --git a/authors.txt b/AUTHORS.txt similarity index 100% rename from authors.txt rename to AUTHORS.txt diff --git a/license.txt b/LICENSE.txt similarity index 100% rename from license.txt rename to LICENSE.txt diff --git a/readme.md b/README.md similarity index 100% rename from readme.md rename to README.md From d708a320943044d06dfd4cd8a5c003776a00355a Mon Sep 17 00:00:00 2001 From: Tobias Bieniek Date: Sat, 9 Mar 2013 19:00:25 +0100 Subject: [PATCH 2/6] Converted AUTHORS and LICENSE files to Markdown .txt files are rendered by Github as plain monospace text. Markdown files however are rendered with a more readable font and formatting. --- AUTHORS.md | 57 +++++++++++++++++++++++++++++++++++++++ AUTHORS.txt | 57 --------------------------------------- LICENSE.txt => LICENSE.md | 4 +-- 3 files changed, 59 insertions(+), 59 deletions(-) create mode 100644 AUTHORS.md delete mode 100644 AUTHORS.txt rename LICENSE.txt => LICENSE.md (89%) diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000000..69dc5d8e20 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,57 @@ +OpenLayers contributors: + +* Antoine Abt +* Mike Adair +* Jeff Adams +* Seb Benthall +* Bruno Binet +* Stéphane Brunner +* Howard Butler +* Bertil Chaupis +* John Cole +* Tim Coulter +* Robert Coup +* Jeff Dege +* Roald de Wit +* Schuyler Erle +* Christian López Espínola +* John Frank +* Sean Gilles +* Pierre Giraud +* Ivan Grcic +* Andreas Hocevar +* Marc Jansen +* Ian Johnson +* Frédéric Junod +* Eric Lemoine +* Philip Lindsay +* Martijn van Oosterhout +* David Overstrom +* Tom Payne +* Corey Puffault +* Peter William Robins +* Gregers Rygg +* Tim Schaub +* Christopher Schmidt +* Cameron Shorter +* Pedro Simonetti +* Paul Spencer +* Paul Smith +* Glen Stampoultzis +* James Stembridge +* Erik Uzureau +* Bart van den Eijnden +* Ivan Willig +* Thomas Wood +* Bill Woodall +* Steve Woodbridge +* David Zwarg + +Some portions of OpenLayers are used under the Apache 2.0 license, available +in doc/licenses/APACHE-2.0.txt. + +Some portions of OpenLayers are used under the MIT license, availabie in +doc/licenses/MIT-LICENSE.txt. + +Some portions of OpenLayers are Copyright 2001 Robert Penner, and are used +under the BSD license, available in doc/licenses/BSD-LICENSE.txt diff --git a/AUTHORS.txt b/AUTHORS.txt deleted file mode 100644 index 057978f513..0000000000 --- a/AUTHORS.txt +++ /dev/null @@ -1,57 +0,0 @@ -OpenLayers contributors: - -Antoine Abt -Mike Adair -Jeff Adams -Seb Benthall -Bruno Binet -Stéphane Brunner -Howard Butler -Bertil Chaupis -John Cole -Tim Coulter -Robert Coup -Jeff Dege -Roald de Wit -Schuyler Erle -Christian López Espínola -John Frank -Sean Gilles -Pierre Giraud -Ivan Grcic -Andreas Hocevar -Marc Jansen -Ian Johnson -Frédéric Junod -Eric Lemoine -Philip Lindsay -Martijn van Oosterhout -David Overstrom -Tom Payne -Corey Puffault -Peter William Robins -Gregers Rygg -Tim Schaub -Christopher Schmidt -Cameron Shorter -Pedro Simonetti -Paul Spencer -Paul Smith -Glen Stampoultzis -James Stembridge -Erik Uzureau -Bart van den Eijnden -Ivan Willig -Thomas Wood -Bill Woodall -Steve Woodbridge -David Zwarg - -Some portions of OpenLayers are used under the Apache 2.0 license, available -in doc/licenses/APACHE-2.0.txt. - -Some portions of OpenLayers are used under the MIT license, availabie in -doc/licenses/MIT-LICENSE.txt. - -Some portions of OpenLayers are Copyright 2001 Robert Penner, and are used -under the BSD license, available in doc/licenses/BSD-LICENSE.txt diff --git a/LICENSE.txt b/LICENSE.md similarity index 89% rename from LICENSE.txt rename to LICENSE.md index cb829cc47d..c68f36e0e7 100644 --- a/LICENSE.txt +++ b/LICENSE.md @@ -4,10 +4,10 @@ authors.txt for full list. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - 1. Redistributions of source code must retain the above copyright notice, this +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - 2. Redistributions in binary form must reproduce the above copyright notice, +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. From 34ec58a8ad6a9b7fba0801379f3cd988c3afb0c7 Mon Sep 17 00:00:00 2001 From: Tobias Bieniek Date: Sat, 9 Mar 2013 19:02:05 +0100 Subject: [PATCH 3/6] LICENSE: Fixed reference to AUTHORS file --- LICENSE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE.md b/LICENSE.md index c68f36e0e7..f451440572 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,5 +1,5 @@ Copyright 2005-2013 OpenLayers Contributors. All rights reserved. See -authors.txt for full list. +AUTHORS.md for full list. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: From f35e4cd3196080d21b2cc2af18f5e553c360644b Mon Sep 17 00:00:00 2001 From: Tobias Bieniek Date: Sat, 9 Mar 2013 19:04:58 +0100 Subject: [PATCH 4/6] test: Renamed readme.md to README.md .. and updated link in main README.md (Github supports relative links now AFAIK) --- README.md | 2 +- test/{readme.md => README.md} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename test/{readme.md => README.md} (100%) diff --git a/README.md b/README.md index 7c40aee999..079d686ed6 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ Run the plovr web server (see above), and either open the `test/ol.html` file in the browser (e.g. ), or run `./build.py test` on the console (headless testing with PhantomJS, make sure to install it first from http://phantomjs.org/download.html). -See also the test-specific [readme](https://github.com/openlayers/ol3/tree/master/test). +See also the test-specific [README](test/README.md). ## Run the linter diff --git a/test/readme.md b/test/README.md similarity index 100% rename from test/readme.md rename to test/README.md From 65397eb73260f00c61a6f572d7e61a1bb8ab484c Mon Sep 17 00:00:00 2001 From: Tobias Bieniek Date: Sat, 9 Mar 2013 20:00:18 +0100 Subject: [PATCH 5/6] test/README: Updated "make test" to "./build.py test" --- test/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/README.md b/test/README.md index 123f19c54c..95b51ebf69 100644 --- a/test/README.md +++ b/test/README.md @@ -22,8 +22,8 @@ With PhantomJS installed, and assuming phantomjs is in the PATH: (Works with PhantomJS 1.6.1, untested with other versions.) -This command can also be run by doing `make test` at the root of ol3. +This command can also be run by doing `./build.py test` at the root of ol3. Tip for TDD'ers: to make PhantomJS run the test suite continuously each time a spec file is changed you can use nosier (http://pypi.python.org/pypi/nosier) -and do `nosier -p test -p src "make test"`. +and do `nosier -p test -p src "./build.py test"`. From 4f8ffbf2ce0557d46688b2dce5f176542751b04a Mon Sep 17 00:00:00 2001 From: Tobias Bieniek Date: Sat, 9 Mar 2013 20:05:31 +0100 Subject: [PATCH 6/6] Added notes that "./build.py test" requires plovr to be running --- CONTRIBUTING.md | 3 ++- test/README.md | 3 +++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0991e72756..956bd83fb2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,7 +50,8 @@ Use the following to run the tests: $ ./build.py test -This command assumes that the `phantomjs` command is on your PATH. +This command assumes that the `phantomjs` command is on your PATH and that the +polvr web server is running (`./build.py serve`). ### The `precommit` target diff --git a/test/README.md b/test/README.md index 95b51ebf69..3d025a53a4 100644 --- a/test/README.md +++ b/test/README.md @@ -24,6 +24,9 @@ With PhantomJS installed, and assuming phantomjs is in the PATH: This command can also be run by doing `./build.py test` at the root of ol3. +Make sure that the polvr web server is running (`./build.py serve`), otherwise +you will most likely see something like `0 specs, 0 failures in 0.001s.`. + Tip for TDD'ers: to make PhantomJS run the test suite continuously each time a spec file is changed you can use nosier (http://pypi.python.org/pypi/nosier) and do `nosier -p test -p src "./build.py test"`.