jenkins-bot has submitted this change and it was merged. Change subject: Improve README. ......................................................................
Improve README. Add a summary section to the README, as well as dependency-checker links and a license. Change-Id: I0f1653d52cce6d79347cbe043874069b2f4c6bd4 --- M README.md 1 file changed, 35 insertions(+), 0 deletions(-) Approvals: Mwalker: Looks good to me, approved jenkins-bot: Verified diff --git a/README.md b/README.md index 1da72c5..5f80156 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@ # OfflineContentGenerator +[![dependency status][1]][2] [![dev dependency status][3]][4] + +Render service (Offline Content Generator) for MediaWiki. + +Ties together the MediaWiki [Collection] extension with +the [mw-ocg-bundler] and [mw-ocg-latexer]/[mw-ocg-texter]/etc backends. ## Installation on Ubuntu @@ -17,3 +23,32 @@ Be aware of these when deploying to a new node version or machine architecture. You may need to `npm rebuild <package name>`. + +## License + +(c) 2014 by Brad Jorsch, C. Scott Ananian, Matthew Walker, Max Seminik + +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 2 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, write to the Free Software Foundation, Inc., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +http://www.gnu.org/copyleft/gpl.html + +[Collection]: https://www.mediawiki.org/wiki/Extension:Collection +[mw-ocg-bundler]: https://github.com/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator-bundler +[mw-ocg-latexer]: https://github.com/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator-latex_renderer +[mw-ocg-texter]: https://github.com/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator-text_renderer + +[1]: https://david-dm.org/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator.png +[2]: https://david-dm.org/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator +[3]: https://david-dm.org/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator/dev-status.png +[4]: https://david-dm.org/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator#info=devDependencies -- To view, visit https://gerrit.wikimedia.org/r/138601 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I0f1653d52cce6d79347cbe043874069b2f4c6bd4 Gerrit-PatchSet: 2 Gerrit-Project: mediawiki/extensions/Collection/OfflineContentGenerator Gerrit-Branch: master Gerrit-Owner: Cscott <[email protected]> Gerrit-Reviewer: Mwalker <[email protected]> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
