cozy-labs/cozy-desktop

View on GitHub
README.md

Summary

Maintainability
Test Coverage
<a href="https://cozy.io">
  <img style="float: left; margin-right: 1em"
       src="https://cdn.rawgit.com/cozy/cozy-guidelines/master/templates/cozy_logo_small.svg"
       alt="Cozy logo">
</a>

# [Cozy][cozy] Drive for Desktop

[![Latest release](https://img.shields.io/github/release/cozy-labs/cozy-desktop/all.svg)](https://github.com/cozy-labs/cozy-desktop/releases)
[![Licence](https://img.shields.io/github/license/cozy/cozy-drive.svg)](https://github.com/cozy/cozy-drive/blob/master/LICENSE)
[![Windows build](https://img.shields.io/appveyor/ci/cozy/cozy-desktop/master.svg?label=windows)](https://ci.appveyor.com/project/cozy/cozy-desktop/branch/master)
[![Linux & macOS build](https://img.shields.io/travis/cozy-labs/cozy-desktop/master.svg?label=mac/linux)](https://travis-ci.org/cozy-labs/cozy-desktop/branches)
[![Code climate](https://img.shields.io/codeclimate/maintainability/cozy-labs/cozy-desktop.svg)](https://codeclimate.com/github/cozy-labs/cozy-desktop)
[![Coverage](https://img.shields.io/codecov/c/github/cozy-labs/cozy-desktop/master.svg?label=coverage)](https://codecov.io/gh/cozy-labs/cozy-desktop/list/master)

Cozy Drive for Desktop allows you to synchronize the files stored in
[your Cozy](https://cozy.io) with your laptop and/or desktop computer. It
replicates your files on your hard drive and apply changes you made on them on
other synced devices and on your online Cozy.

_This is where the app is being developped. If you just want to install it,
please see the **[Download][download]** page._

## Contributing

- [Give us some feedback](./doc/feedback.md)
- [Translate the app][transifex]

### Working on the code

- [Setting up a development environment](./doc/developer/setup.md)
- [API & Code organization][api] (offline version: `./doc/api/index.html`)
- [Testing](./doc/developer/test.md)
- [Review code changes & documentation][pulls]


## License

Cozy Drive for Desktop is developed by [Cozy Cloud][cozy] and distributed
under the [AGPL v3 license][agpl-3.0].

[cozy]: https://cozy.io
[download]: https://cozy.io/en/download/
[issues]: https://github.com/cozy-labs/cozy-desktop/issues
[transifex]: https://www.transifex.com/cozy/cozy-desktop/
[pulls]: https://github.com/cozy-labs/cozy-desktop/pulls
[api]: https://cozy-labs.github.io/cozy-desktop/doc/api/
[agpl-3.0]: https://www.gnu.org/licenses/agpl-3.0.en.html