summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/extensions/SemanticMediaWiki/README.md')
-rw-r--r--www/wiki/extensions/SemanticMediaWiki/README.md81
1 files changed, 81 insertions, 0 deletions
diff --git a/www/wiki/extensions/SemanticMediaWiki/README.md b/www/wiki/extensions/SemanticMediaWiki/README.md
new file mode 100644
index 00000000..86005da9
--- /dev/null
+++ b/www/wiki/extensions/SemanticMediaWiki/README.md
@@ -0,0 +1,81 @@
+# Semantic MediaWiki
+
+[![Build Status](https://secure.travis-ci.org/SemanticMediaWiki/SemanticMediaWiki.svg?branch=master)](http://travis-ci.org/SemanticMediaWiki/SemanticMediaWiki)
+[![Code Coverage](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticMediaWiki/badges/coverage.png?s=f3501ede0bcc98824aa51501eb3647ecf71218c0)](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticMediaWiki/)
+[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticMediaWiki/badges/quality-score.png?s=d9aac7e68e6554f95b0a89608cbc36985429d819)](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticMediaWiki/)
+[![Latest Stable Version](https://poser.pugx.org/mediawiki/semantic-media-wiki/version.png)](https://packagist.org/packages/mediawiki/semantic-media-wiki)
+[![Packagist download count](https://poser.pugx.org/mediawiki/semantic-media-wiki/d/total.png)](https://packagist.org/packages/mediawiki/semantic-media-wiki)
+
+Semantic MediaWiki (a.k.a. SMW) is a free, open-source extension to [MediaWiki](https://www.semantic-mediawiki.org/wiki/MediaWiki) – the wiki software that
+powers Wikipedia – that lets you store and query data within the wiki's pages.
+
+Semantic MediaWiki is also a full-fledged framework, in conjunction with
+many spinoff extensions, that can turn a wiki into a powerful and flexible
+knowledge management system. All data created within SMW can easily be
+published via the [Semantic Web](https://www.semantic-mediawiki.org/wiki/Semantic_Web),
+allowing other systems to use this data seamlessly.
+
+For a better understanding of how Semantic MediaWiki works, have a look at [deployed in 5 min](https://vimeo.com/82255034) and the [Sesame](https://vimeo.com/126392433), [Fuseki ](https://vimeo.com/118614078) triplestore video, or
+browse the [wiki](https://www.semantic-mediawiki.org) for a more comprehensive introduction.
+
+## Requirements
+
+- PHP 5.6 or later
+- MediaWiki 1.27 or later
+- MySQL 5+, SQLite 3+ or PostgreSQL 9.x
+
+A list of supported PHP versions, MediaWiki versions and database systems per Semantic MediaWiki
+release can be found in the [compatibility matrix](docs/COMPATIBILITY.md).
+
+## Installation
+
+The recommended way to install Semantic MediaWiki is by using [Composer][composer]. See the detailed
+[installation guide](docs/INSTALL.md) as well as the information on [compatibility](docs/COMPATIBILITY.md).
+
+## Documentation
+
+Most of the documentation can be found on the [wiki for Semantic MediaWiki](https://www.semantic-mediawiki.org).
+A small core of documentation also comes bundled with the software itself. This documentation is minimalistic
+and less explanatory then what can be found on the SMW wiki. It is however always kept up to date, and applies
+to the version of the code it comes bundled with. The most important files are linked below.
+
+* [User documentation](docs/README.md)
+* [Technical documentation](docs/technical/README.md)
+
+## Contribution and support
+
+[![Twitter](https://www.semantic-mediawiki.org/w/images/c/c9/Twitter_icon.jpg)](https://twitter.com/#!/semanticmw)
+[![Facebook](https://www.semantic-mediawiki.org/w/images/thumb/7/77/677166248.png/30px-677166248.png)](https://www.facebook.com/pages/Semantic-MediaWiki/160459700707245)
+[![Google+](https://www.semantic-mediawiki.org/w/images/a/ae/30px-Google%2B.png)](https://plus.google.com/115301028320198614441/posts)
+
+Many people have contributed to SMW. A list of people who have made contributions in the past can
+be found [here][contributors] or on the [wiki for Semantic MediaWiki](https://www.semantic-mediawiki.org/wiki/Help:SMW_Project#Contributors).
+The overview on [how to contribute](https://github.com/SemanticMediaWiki/SemanticMediaWiki/blob/master/docs/CONTRIBUTING.md)
+provides information on the different ways available to do so.
+
+If you have remarks, questions, or suggestions, please send them to <semediawiki-users@lists.sourceforge.net>.
+You can subscribe to this list [here](https://sourceforge.net/projects/semediawiki/lists/semediawiki-user).
+
+If you want to contribute work to the project please subscribe to the developers mailing list and
+have a look at the contribution guideline.
+
+* [File an issue](https://github.com/SemanticMediaWiki/SemanticMediaWiki/issues)
+* [Submit a pull request](https://github.com/SemanticMediaWiki/SemanticMediaWiki/pulls)
+* Ask a question on [the mailing list](https://www.semantic-mediawiki.org/wiki/Mailing_list)
+* Ask a question on the #semantic-mediawiki IRC channel on Freenode.
+
+## Tests
+
+This extension provides unit and integration tests and are normally run by a [continues integration platform][travis]
+but can also be executed locally using the shortcut command `composer phpunit` from the extension base directory. A more comprehensive introduction can be found under the [test section](/tests/README.md#running-tests).
+
+## License
+
+[GNU General Public License, version 2 or later][gpl-licence]. The COPYING file explains SMW's copyright and license.
+
+[contributors]: https://github.com/SemanticMediaWiki/SemanticMediaWiki/graphs/contributors
+[travis]: https://travis-ci.org/SemanticMediaWiki/SemanticMediaWiki
+[mw-testing]: https://www.mediawiki.org/wiki/Manual:PHP_unit_testing
+[gpl-licence]: https://www.gnu.org/copyleft/gpl.html
+[composer]: https://getcomposer.org/
+[smw-installation]: https://www.semantic-mediawiki.org/wiki/Help:Installation