summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticResultFormats/README.md
diff options
context:
space:
mode:
authorYaco <franco@reevo.org>2020-06-04 11:01:00 -0300
committerYaco <franco@reevo.org>2020-06-04 11:01:00 -0300
commitfc7369835258467bf97eb64f184b93691f9a9fd5 (patch)
treedaabd60089d2dd76d9f5fb416b005fbe159c799d /www/wiki/extensions/SemanticResultFormats/README.md
first commit
Diffstat (limited to 'www/wiki/extensions/SemanticResultFormats/README.md')
-rw-r--r--www/wiki/extensions/SemanticResultFormats/README.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/www/wiki/extensions/SemanticResultFormats/README.md b/www/wiki/extensions/SemanticResultFormats/README.md
new file mode 100644
index 00000000..4806f992
--- /dev/null
+++ b/www/wiki/extensions/SemanticResultFormats/README.md
@@ -0,0 +1,56 @@
+# Semantic Result Formats
+
+[![Build Status](https://secure.travis-ci.org/SemanticMediaWiki/SemanticResultFormats.svg?branch=master)](http://travis-ci.org/SemanticMediaWiki/SemanticResultFormats)
+[![Code Coverage](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticResultFormats/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticResultFormats/?branch=master)
+[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticResultFormats/badges/quality-score.png?s=a2f091e91cb9c8aa297e028f2f30d99153446796)](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticResultFormats/)
+[![Latest Stable Version](https://poser.pugx.org/mediawiki/semantic-result-formats/version.png)](https://packagist.org/packages/mediawiki/semantic-result-formats)
+[![Packagist download count](https://poser.pugx.org/mediawiki/semantic-result-formats/d/total.png)](https://packagist.org/packages/mediawiki/semantic-result-formats)
+
+Semantic Result Formats (a.k.a. SRF) is an extension to MediaWiki that bundles a number of result
+formats for [Semantic MediaWiki's][smw] inline queries. The individual formats can be added to the
+installation independently. For more information, visit the [SRF homepage][srf] or consult the
+[release notes](RELEASE-NOTES.md).
+
+## Requirements
+
+- PHP 7.0 or later
+- MediaWiki 1.31 or later
+- Semantic MediaWiki 3.0 or later
+
+## Installation
+
+The recommended way to install this extension is by using [Composer][composer]. See the detailed
+[installation guide](docs/INSTALL.md) which also contains information about compatibility and
+configuration.
+
+## Contribution and support
+
+Development is coordinated by James Hong Kong and Jeroen De Dauw.
+
+If you have remarks, questions, or suggestions, please ask them on semediawiki-users@lists.sourceforge.net.
+You can subscribe to this list [here](https://lists.sourceforge.net/lists/listinfo/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 guildline](/CONTRIBUTING.md).
+A list of people who have made contributions in the past can be found [here][contributors].
+
+* [File an issue](https://github.com/SemanticMediaWiki/SemanticResultFormats/issues)
+* [Submit a pull request](https://github.com/SemanticMediaWiki/SemanticResultFormats/pulls)
+* Ask a question on [the mailing list](https://www.semantic-mediawiki.org/wiki/Mailing_list)
+
+## 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.
+
+## License
+
+Generally published under [GNU General Public License 2.0 or later][licence] together with
+third-party plugins and their license.
+
+[smw]: https://github.com/SemanticMediaWiki/SemanticMediaWiki
+[travis]: https://travis-ci.org/SemanticMediaWiki/SemanticResultFormats
+[srf]: https://www.semantic-mediawiki.org/wiki/Extension:Semantic_Result_Formats
+[composer]: https://getcomposer.org/
+[contributors]: https://github.com/SemanticMediaWiki/SemanticResultFormats/graphs/contributors
+[licence]: https://www.gnu.org/copyleft/gpl.html