AChep/literaryclock

View on GitHub
README.md

Summary

Maintainability
Test Coverage
Literary Clock
==========
[![Code Climate](https://codeclimate.com/github/AChep/literaryclock/badges/gpa.svg)](https://codeclimate.com/github/AChep/literaryclock) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/cb745166ea82404ba65b45e39faf89cb)](https://www.codacy.com/app/AChep/literaryclock?utm_source=github.com&utm_medium=referral&utm_content=AChep/literaryclock&utm_campaign=Badge_Grade)

<img alt="Main screen: Light" align="right" height="400"
   src="https://github.com/AChep/literaryclock/raw/master/screenshots/screenshot2.jpg" />

<img alt="Main screen: Dark" align="right" height="400"
   src="https://github.com/AChep/literaryclock/raw/master/screenshots/screenshot1.jpg" />

*A clock? Literary?*

Literary Clock represents current time in a form of literature quotes. It serves as an example of material design principles.

 - **[Help us to translate it](https://crowdin.com/project/literaryclock)** _(even a short look would be helpful)_
 
<a href="https://play.google.com/store/apps/details?id=com.artemchep.literaryclock">
  <img alt="Get Literary Clock on Google Play" vspace="20"
       src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" height="60" />
</a>

Report a bug or request a feature
----------------
Before creating a new issue please make sure that same or similar issue is not already created by checking [open issues][2] and [closed issues][3] *(please note that there might be multiple pages)*. If your issue is already there, don't create a new one, but leave a comment under already existing one.

Checklist for creating issues:

- Keep titles short but descriptive.
- For feature requests leave a clear description about the feature with examples where appropriate.
- For bug reports leave as much information as possible about your device, android version, etc.
- For bug reports also write steps to reproduce the issue.

[Create new issue][1]

Creating your Literary Clock
----------------
We welcome all developers to use our source code to create applications on our platform.
There are several things we require from **all developers** for the moment:

1. Kindly **do not** use our standard logo as your app's logo.
2. Please remember to read and follow the [license][4].

Versioning
----------------
For transparency in a release cycle and in striving to maintain backward compatibility, a project should be maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we should adhere to these rules whenever possible.

Releases will be numbered with the following format: `<major>.<minor>.<patch>` and constructed with the following guidelines:
- Breaking backward compatibility bumps the major while resetting minor and patch
- New additions without breaking backward compatibility bumps the minor while resetting the patch
- Bug fixes and misc changes bumps only the patch

For more information on SemVer, please visit http://semver.org/.


[1]: https://github.com/AChep/literaryclock/issues/new
[2]: https://github.com/AChep/literaryclock/issues?state=open
[3]: https://github.com/AChep/literaryclock/issues?state=closed
[4]: https://github.com/AChep/literaryclock/blob/master/LICENSE