Commit Graph

99 Commits

Author SHA1 Message Date
Thomas Waldmann 871da25865
remove bountysource badge 2023-10-10 20:31:21 +02:00
Thomas Waldmann 04ff8d6524
fix README 2023-08-26 13:55:59 +02:00
Paul D a85b643866 Docs grammar fixes.
One cannot "to not x", but one can "not to x".
Avoiding split infinitives gives the added bonus that machine
translation yields better results.

setup (n/adj) vs set(v) up. We don't "I setup it" but "I set it up".

Likewise for login(n/adj) and log(v) in, backup(n/adj) and back(v) up.
2022-12-29 00:01:48 +00:00
Thomas Waldmann d527429339 update README for borg2 2022-10-03 20:23:56 +02:00
Yornik Heyl 3393412364
Update README.rst
The Webchat link still pointed to Freenode.
2021-06-03 16:53:02 +02:00
Robin Schneider fb38ba579f
Use HTTPS everywhere (mechanical edit using util from https-everywhere)
Ref: https://github.com/EFForg/https-everywhere/tree/master/utils/rewriter

```Shell
~/src/EFForg/https-everywhere/utils/rewriter/rewriter.js .
```

A few changes were reset/fixed manually before the commit.
2020-12-22 16:36:40 +01:00
Samuel fa331c3e3b
Change references of Travis to GitHub Actions (#5536)
s/travis/github actions/g, fixes #5528
2020-12-03 20:10:53 +01:00
Thomas Waldmann b45874bead ObfuscateSize compressor 2020-12-02 14:21:42 +01:00
Thomas Waldmann 9d2cabc4d2 update travis-ci.org -> .com (master) 2020-11-02 23:06:15 +01:00
TW 73412ee24a
Merge pull request #5051 from finefoot/patch-9
Fix typos
2020-03-20 16:57:15 +01:00
finefoot a2a4d88524
Fix typos 2020-03-20 10:57:31 +01:00
Thalian 54af1104ef [DOCS] #4587 – Make Sphinx warnings break docs build
Add width 100% to image.
2020-03-16 19:06:00 +01:00
Thomas Waldmann 742f978b89 README: new URL for funding options
This is a forward port of d9c5dfb55b
2019-04-27 09:22:31 -05:00
Lars-Magnus Skog 35de001deb Fix tiny typo in README 2018-11-28 03:05:46 +01:00
Rémi Oudin 862d1dfb0f Link to offline documentation
Add a link to the offline documentation in README.rst.
Refers https://github.com/borgbackup/borg/issues/3502
2018-02-03 17:34:45 +01:00
Thomas Waldmann 2588e50f0b readme / docs: mention zstd 2017-12-18 22:55:00 +01:00
Michael Rupert 6dd54f93ce fixed support links (#3379)
fixed support links
2017-11-26 05:10:22 +01:00
Michael Rupert 71fbac94fb Moved Support to .org (#3360)
docs: moved support options to www.borgbackup.org
2017-11-25 03:15:18 +01:00
Thomas Waldmann 61d6c58241 update / rephrase cygwin / WSL status, fixes #3174 2017-11-05 19:24:49 +01:00
Thomas Waldmann c8441b5b3d readme: -e is required in borg 1.1 2017-10-12 16:14:32 +02:00
Thomas Waldmann 7c9561afa2 show/link new screencasts in README, fixes #2936 2017-09-07 19:15:53 +02:00
Steve Groesz 2bcbf8144e Add bountysource badge (#2581)
add bountysource badge, fixes #2558
2017-06-03 14:40:08 +02:00
Thomas Waldmann 60df56bd11 README: how to help the project 2017-05-22 18:22:09 +02:00
schuft69 fe2d648465 Update README.rst 2017-05-22 08:23:08 +02:00
Thomas Waldmann bf69b049e9 be clear about what buzhash is used for, fixes #2390
and want it is not used for (deduplication).

also say already in the readme that we use a cryptohash
for dedupe, so people don't worry.
2017-04-25 23:38:55 +02:00
Marian Beermann fd587331d7 Update link to security contact
Currently this move was only done in master, so point to latest.
Might be generally a good idea in case it changes and no release was done
since the responsibility changed.
2016-12-22 15:21:42 +01:00
Nathan Musoke dc5f954afa Update link to security contact
Information about security contact has moved.
2016-12-22 15:20:09 +01:00
Thomas Waldmann 6b6ddecd93 document windows 10 linux subsystem install
also add note about remote repos being broken on cygwin.
2016-12-17 00:25:49 +01:00
Marian Beermann 64428da030 README: fix code-block without an argument 2016-11-27 20:16:41 +01:00
Antoine Beaupré fbada18b0d display README correctly on PyPI
I have discovered that PyPI is way more sensitive to RST warnings than
other platforms: warnings and errors will make the document not show
up correctly, which is currently the case here:

https://pypi.python.org/pypi/borgbackup/

the suggested changes remove Sphinx-specific markup from the output,
namely the badges and `|replacement|` patterns, but also the
`higlight` directive. this also requires adding tags to the README to
mark the badges to remove and removal of the `none` argument for the
`.. code-block::` element which was not having any significant in
Sphinx anyways.
2016-11-24 09:09:15 -05:00
Antoine Beaupré 319ecd81bb fix links in standalone README
github and standalone docutils don't parse :ref: tags correctly
2016-11-04 20:58:28 -04:00
Antoine Beaupré 0cda9d6bd3 add link to security contact in README 2016-11-04 20:58:27 -04:00
Antoine Beaupré b4d0388785 move security verification to support section
the rationale is to simplify the README file to the bare
minimum. security researchers will be able to find the contact
information if they look minimally and people installing the software
will find a link where relevant (in binary releases only, since all
the others have other trust paths)
2016-11-04 20:58:27 -04:00
Antoine Beaupré 5def2350d0 fix PDF rendering structure
without those changes, all of the toctree document headings do not
show up. they are considered to be "below" the last heading of the
README file.

we also remove the "Notes" section from the readme as there is only
one note, regarding the fork.

we introduce a stub "introduction" element in the toctree, otherwise
it is impossible for the PDF rendered to render the README correctly.

this is to workaround a bug in the PDF renderer.
2016-11-04 16:01:18 -04:00
Antoine Beaupré 7f9a147e46 move fork differences to FAQ
it seems now that the fork is more of historical value than a current
thing. people interested in the differences between borg and attic can
look in the FAQ, but I do not see why this is present in the README.

a new section regarding compatibility is created to keep that warning
in place.
2016-11-04 12:34:41 -04:00
Marian Beermann ac8d65cc47 Fix second block in "Easy to use" section not showing on GitHub
Fixes #1576
2016-09-06 13:03:59 +02:00
Thomas Waldmann 45d72722af add bestpractices badge 2016-09-03 21:11:47 +02:00
Thomas Waldmann 2e1cf17dd5 add release signing key / security contact to README, fixes #1560 2016-09-03 19:23:40 +02:00
Lee Bousfield 0a4a95eb17
Remove trailing whitespace 2016-07-27 10:05:51 -04:00
Thomas Waldmann cf4d761042 docs: fix the highlighting
default is "python", that's why some help fragments and bash scripts looked strange.
2016-07-11 23:16:53 +02:00
Thomas Waldmann 20eab2b5c8 update frontpage / support docs
less items in frontpage link list
add IRC chat link
minor other changes
2016-07-04 22:37:24 +02:00
Thomas Waldmann 4b73ebc613 update readthedocs urls, fixes #991 2016-04-29 03:19:27 +02:00
Thomas Waldmann bc854e3e64 docs: use /path/to/repo, fixes #901
/mnt/backup was confusing as people like to mount their backup disk on /mnt/backup,
but borg init /mnt/backup does not work if that directory already exists because it is
the mountpoint. it would work, if /mnt was the mountpoint, but that is not obvious
and also unusual.
2016-04-15 03:35:37 +02:00
petrcech 351da4c88f Update README.rst to new changelog location
Update README.rst to new changelog location in docs/changes.rst
2016-03-03 07:08:19 +01:00
Thomas Waldmann 64c7b5db21 fix travis badge 2016-02-27 19:05:46 +01:00
Thomas Waldmann af2eaaabd4 update and improve docs
use the travis status image as png as svg does not show an image in firefox.
2016-02-27 17:22:56 +01:00
Herover 29b84a1b43 Use https on updated license link 2016-01-25 13:33:48 +01:00
Herover 7cb6b5657a Fix dead link to license 2016-01-24 19:26:05 +01:00
Stefan Tatschner 897c763a5b Fix markup in README.rst
Github generated wrong markup, because of a few whitespace errors.
This patch fixes the rst markup of the README.rst file.
2016-01-18 16:30:27 +01:00
Robin Schneider 576348a9d4
Use HTTPS everywhere. Especially when the website already redirects to HTTPS. 2016-01-17 22:31:08 +01:00