[tx-robot] updated from transifex
[owncloud:sebas-mirall.git] / README.md
1
2 # Mirall
3
4 ## Introduction
5
6 Mirall synchronizes your folders with another computer.
7
8 The ultimate goals of Mirall are:
9
10 * Network location aware: should not try to sync against your NAS if you are
11   not in the home network
12 * It is a zero-interaction tool. So forget about resolving conflicts.
13 * It should work silently and realiably.
14
15 Mirall is in early stages of development, and may still eat your
16 files or hang your computer.
17
18 * Network location awareness not implemented yet
19 * Current version supports local and remote (sftp and smb) folders.
20 * It is powered by csync (http://www.csync.org), however
21   the user does not know and other tools will be incorporated to provide other
22   functionality.
23
24 ## Current issues
25
26 * No sane way to backup conflicting versions yet, this should be solved
27   in a near csync release (--conflictcopy, available in Jann's branch).
28   Right now the newest copy wins.
29 * You can't remove folder configurations
30   Workaround: delete ~/.local/share/data/Mirall/folders/$alias and restart
31 * Some tasks block the GUI (initial setup of watchers)
32 * May be some concurrency issues
33
34 ## Roadmap
35
36 * Improve robustness to minimize user interaction
37 * Improve feedback and sync results
38 * Add support for other folder types: tarsnap, duplicity, git (SparkleShare)
39
40 ## Requirements
41
42 * Linux (currently it uses inotify to detect file changes)
43 * unison installed in the local and remote machine
44   (you should not care if you got Mirall with your favorite
45    distribution)
46
47 ## Download
48
49 ### openSUSE
50
51 * 1-click install available in software.opensuse.org
52
53 http://software.opensuse.org/search?q=mirall&baseproject=ALL&lang=en&include_home=true&exclude_debug=true
54
55 ### Source code
56
57 * http://github.com/dmacvicar/mirall
58
59 ## Building the source code
60
61 You need Qt 4.7 and cmake:
62
63     mkdir build
64     cd build
65     cmake ..
66     make
67
68 To generate a tarball:
69
70     mkdir build
71     cd build
72     cmake ..
73     make package_source
74
75 ## Authors
76
77 * Duncan Mac-Vicar P. <duncan@kde.org>
78
79 ## License
80
81     This program is free software; you can redistribute it and/or modify
82     it under the terms of the GNU General Public License as published by
83     the Free Software Foundation; either version 2 of the License, or
84     (at your option) any later version.
85
86     This program is distributed in the hope that it will be useful, but
87     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
88     or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
89     for more details.
90
91