From d462c8838f6682624cf92d330c36e1c7ba540001 Mon Sep 17 00:00:00 2001 From: Daniel Molkentin Date: Sun, 9 Nov 2014 22:58:16 +0100 Subject: [PATCH] Adapt and expand README --- CONTRIBUTING.md | 8 ++++---- README.md | 41 ++++++++++++++++++++++++++++++++++------- 2 files changed, 38 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8dfa16265..cbab66daf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. -[template]: https://raw.github.com/owncloud/mirall/master/issue_template.md +[template]: https://raw.github.com/owncloud/client/master/issue_template.md [mailinglist]: https://mail.kde.org/mailman/listinfo/owncloud [forum]: http://forum.owncloud.org/ [irc]: http://webchat.freenode.net/?channels=owncloud&uio=d4 @@ -31,16 +31,16 @@ features, by not reporting duplicate issues. Thanks for wanting to contribute source code to ownCloud. That's great! -Before we're able to merge your code to mirall, you need to sign +Before we're able to merge your code to ownCloud Desktop Client, you need to sign our [Contributor Agreement][agreement]. -Please read the [Desktop Client Manual][mirallman] and the [Developer +Please read the [Desktop Client Manual][desktopman] and the [Developer Manuals][devmanual] to get useful infos like how to create your first application or how to test the ownCloud code with phpunit. [agreement]: http://owncloud.org/about/contributor-agreement/ [devmanual]: http://owncloud.org/dev/ -[mirallman]: http://doc.owncloud.org/desktop/1.1/ +[desktopman]: http://doc.owncloud.org/desktop/1.1/ ## Translations Please submit translations via [Transifex][transifex]. diff --git a/README.md b/README.md index 2ced9c8c9..c22cc81f9 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# Mirall +# ownCloud Desktop Client ## Introduction -Mirall is a tool to synchronize files from ownCloud Server with your computer. -It uses OCSync as its syncing backend. +The ownCloud Desktop Client is a tool to synchronize files from ownCloud Server +with your computer. ## Download @@ -13,19 +13,46 @@ It uses OCSync as its syncing backend. ### Source code -* https://github.com/owncloud/mirall +Tehe ownCloud Desktop Client is developed in Git. Since Git makes it easy to +fork and improve the source code and to adapt it to your need, many copies +can be found on the Internet, in particular on GitHub. However, the +authoritative pepository maintained by the developers is located at +https://github.com/owncloud/client. ## Building the source code Please refer to doc/building.rst, or [Building the Client](http://doc.owncloud.org/desktop/1.5/building.html) -in the ownCloud client manual. +in the ownCloud Desktop Client manual. -## Authors +## Maintainers and Contributors + +The maintainers of this repository are: -* Duncan Mac-Vicar P. (original Mirall author) * Klaas Freitag * Daniel Molkentin +* Markus Goetz +* Olivier Goffart + +ownCloud Desktop Client is developed by the ownCloud community and receives +patches from a variety of authors. + +## Reporting issues and contributing + +If you find any bugs or have any suggestion for improvement, please +file an issue at https://github.com/owncloud/client/issues. Do not +contact the authors directly by mail, as this increases the chance +of your report being lost. + +If you created a patch, please submit a [Pull +Request](https://github.com/owncloud/mirall/pulls). For non-trivial +patches, we need you to sign the [Contributor +Agreement](https://owncloud.org/contribute/agreement) before +we can accept your patch. + +If you want to contact us, e.g. before starting a more complex feature, +you can join us at +[#owncloud-client-dev](irc://irc.freenode.net/#owncloud-client-dev). ## License