1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-27 18:28:42 +00:00
Commit graph

37 commits

Author SHA1 Message Date
Thomas Waldmann
e7f25d7821 docs: use zlib,6 compression in some examples, fixes #275
This is what attic used by default, but borgbackup defaults to "no compression".

I just adjusted the command invocation, so we can keep the example output
(which shows that stuff was compressed).

Also: add FAQ item about compression.
2015-10-16 01:18:37 +02:00
Antoine Beaupré
f31b4a639b fix headings in README
this makes it consistent with the rest of the documentation
2015-10-12 23:36:48 -04:00
Antoine Beaupré
6b604ac28c Merge remote-tracking branch 'origin/master' into rtd-theme
Conflicts:
	README.rst
2015-10-12 23:29:45 -04:00
Antoine Beaupré
e59045fd24 move links from the sidebar to the readme
it seems sidebar links are not supported by the RTD theme just yet: https://github.com/snide/sphinx_rtd_theme/issues/254
2015-10-12 23:27:59 -04:00
Antoine Beaupré
da2ec7995f fix homepage URL in all remaining places
we update the documentation to mention the automatic updates, and also
remove the hack in the makefile to update the github.io pages, which
are gone.
2015-10-09 15:54:04 -04:00
Antoine Beaupré
6cd6e286af clarify which systems have binaries 2015-10-07 18:37:35 -04:00
Antoine Beaupré
5f4db6487a fix README links so they work in github 2015-10-07 18:33:43 -04:00
Antoine Beaupré
e2f3527353 don't duplicate OS list
we merge the "easy installation" and "platforms" paragraphs together in a neater phrasing
2015-10-07 18:32:21 -04:00
Antoine Beaupré
ef5d8d0879 fix link to install docs 2015-10-07 18:04:36 -04:00
Antoine Beaupré
1579be33df fix links to changelog and authors 2015-10-07 17:54:43 -04:00
Antoine Beaupré
6629772760 make readme a little more readable
link to source documents for people that are reading just the README without a web browser
hyperlink to the changes document as well
2015-10-07 17:54:43 -04:00
Thomas Waldmann
a3d967bdff hint to single-file pyinstaller binaries from README 2015-09-28 00:41:40 +02:00
Thomas Waldmann
ff64b4c424 be more precise about OpenBSD/NetBSD support
xattrs/ACLs need platform specific code and new have none (yet) for them.
2015-09-16 11:53:53 +02:00
Thomas Waldmann
f138d06dd5 more platform support, works on py 3.5
xattrs and ACLs on OpenBSD and NetBSD need development or adaptation of
the platform-specific code.
2015-09-16 11:44:53 +02:00
Thomas Waldmann
1d16e7a37c compression: update / refine docs 2015-08-15 15:45:15 +02:00
Thomas Waldmann
1724241d0c README: mention lzma and lz4 compression 2015-08-10 20:45:15 +02:00
Thomas Waldmann
6164640ecc add codecov.io badge 2015-08-08 18:31:57 +02:00
Thomas Waldmann
58d57df46d improve README.rst 2015-08-06 16:39:50 +02:00
Thomas Waldmann
d65ca51d54 deduplicate and refactor the docs
README.rst (shown on github and also at the start of the html docs) shall
be like an elevator speech - convince readers in a very short time.
this is most important, everything else can come after we got the reader's interest.

include README into docs to avoid duplication.
also include CHANGES into docs.
add developer docs, move examples from tox.ini there
add separate support docs
remove glossary, most of what was there can be understood by an admin from context
move attic and compatibility note to the end
2015-08-06 12:59:51 +02:00
Thomas Waldmann
300c7351e7 be more verbose about the great deduplication algorithm 2015-07-27 23:02:52 +02:00
Per Guth
60dfde2dc6 Reference to BorgWeb 2015-07-27 14:45:32 +02:00
Per Guth
30d47cb68a Fixed *ALL* the links! 2015-07-27 14:41:43 +02:00
Per Guth
bcdfda7ef0 Linked "issue #1" to issue #1. 2015-07-27 14:38:03 +02:00
Thomas Waldmann
9880ac7ba8 README: mention pytest 2015-06-12 00:11:16 +02:00
Thomas Waldmann
e92d94cb07 rephrase compatibility note 2015-06-11 22:54:33 +02:00
Thomas Waldmann
c32f4b64b1 integrate CHANGES-borg.txt into CHANGES and README.rst 2015-05-14 00:37:09 +02:00
Thomas Waldmann
35d06afd6b get rid of some .borg, be consistent with the backup repo name and path
it's pretty useless to have .borg as a directory extension, especially
since there is a README in there stating that this is a borg repo.

conistency:
"backup" is always used as relative backup repository path
"/mnt/backup" is always used as absolute repository path
2015-05-13 15:02:33 +02:00
Thomas Waldmann
cb5c9b63b3 fork: s/attic/borg/g, fix URLs, add new section to AUTHORS
use borg instead attic except at the places where it was used:
- as toplevel package name, directory name, file name
- to refer to original attic

remove sphinx upload make command, will be replaced by github.io site later

remove references to binary downloads and linux packages for now

remove some software name references, fix grammar

use borgbackup rather than borg-backup (or borg) in URLs,
less name collision issues, better search results, no validity issues with "-"
2015-05-13 15:02:33 +02:00
Jonas Borgström
10ef7fe0f2 Move website to attic-backup.org 2014-03-09 15:12:07 +01:00
Dan Christensen
400ea33eaa Update README.rst. 2014-02-03 21:48:22 -05:00
Jonas Borgström
3290aa943f Update README.rst with the correct way to run the test suite 2014-02-03 23:03:25 +01:00
Jonas Borgström
9ebeb0f98d Documentation: Added info about mailing list 2013-08-06 22:17:28 +02:00
Jonas Borgström
05a14c3be3 Attic 0.7 2013-08-05 20:54:27 +02:00
Jonas Borgström
b718a443a8 Project rename 2013-07-09 20:14:18 +02:00
Jonas Borgström
a5a73ca926 Fix reST syntax
[ci skip]
2013-07-08 21:57:25 +02:00
Jonas Borgström
a9272ce913 Update documentation 2013-07-08 21:19:50 +02:00
Jonas Borgström
f827b99ffe Improved documentation. 2013-07-05 12:32:56 +02:00
Renamed from README (Browse further)