octoleo/syncthing
1
0
Fork 0
mirror of https://github.com/octoleo/syncthing.git synced 2024-12-23 11:28:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2261 from rumpelsepp/readme-update

Browse Source 
Cleanup markdown inline link mess
This commit is contained in:
Jakob Borg 2015-09-27 09:28:51 +02:00
commit 84ee86f6b3
1 changed files with 20 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -1,5 +1,4 @@
Syncthing # Syncthing
=========
[![Latest Build (Official)](https://img.shields.io/jenkins/s/http/build.syncthing.net/syncthing.svg?style=flat-square)](http://build.syncthing.net/job/syncthing/lastBuild/) [![Latest Build (Official)](https://img.shields.io/jenkins/s/http/build.syncthing.net/syncthing.svg?style=flat-square)](http://build.syncthing.net/job/syncthing/lastBuild/)
[![AppVeyor Build](https://img.shields.io/appveyor/ci/calmh/syncthing/master.svg?style=flat-square)](https://ci.appveyor.com/project/calmh/syncthing) [![AppVeyor Build](https://img.shields.io/appveyor/ci/calmh/syncthing/master.svg?style=flat-square)](https://ci.appveyor.com/project/calmh/syncthing)
@ -11,8 +10,7 @@ This is the Syncthing project which pursues the following goals:
1. Define a protocol for synchronization of a folder between a number of 1. Define a protocol for synchronization of a folder between a number of
collaborating devices. This protocol should be well defined, unambiguous, collaborating devices. This protocol should be well defined, unambiguous,
easily understood, free to use, efficient, secure and language neutral. easily understood, free to use, efficient, secure and language neutral.
This is called the [Block Exchange This is called the [Block Exchange Protocol][1].
Protocol](https://github.com/syncthing/specs/blob/master/BEPv1.md).
2. Provide the reference implementation to demonstrate the usability of 2. Provide the reference implementation to demonstrate the usability of
said protocol. This is the `syncthing` utility. We hope that said protocol. This is the `syncthing` utility. We hope that
@ -22,38 +20,38 @@ The two are evolving together; the protocol is not to be considered
stable until Syncthing 1.0 is released, at which point it is locked down stable until Syncthing 1.0 is released, at which point it is locked down
for incompatible changes. for incompatible changes.
Getting Started ## Getting Started
---------------
Take a look at the [getting started Take a look at the [getting started guide][2].
guide](http://docs.syncthing.net/intro/getting-started.html).
There are a few examples for keeping Syncthing running in the background There are a few examples for keeping Syncthing running in the background
on your system in [the etc directory](https://github.com/syncthing/syncthing/blob/master/etc). on your system in [the etc directory][3].
There is an IRC channel, `#syncthing` on Freenode, for talking directly There is an IRC channel, `#syncthing` on [Freenode][4], for talking directly
to developers and users. to developers and users.
Building ## Building
--------
Building Syncthing from source is easy, and there's a Building Syncthing from source is easy, and there's a [guide][5].
[guide](http://docs.syncthing.net/dev/building.html).
that describes it for both Unix and Windows systems. that describes it for both Unix and Windows systems.
Signed Releases ## Signed Releases
---------------
As of v0.10.15 and onwards, git tags and release binaries are GPG signed As of v0.10.15 and onwards, git tags and release binaries are GPG signed
with the key D26E6ED000654A3E (see https://syncthing.net/security.html). with the key D26E6ED000654A3E (see https://syncthing.net/security.html).
For release binaries, MD5 and SHA1 checksums are calculated and signed, For release binaries, MD5 and SHA1 checksums are calculated and signed,
available in the md5sum.txt.asc and sha1sum.txt.asc files. available in the md5sum.txt.asc and sha1sum.txt.asc files.
Documentation ## Documentation
=============
Please see the [Syncthing Please see the [Syncthing documentation site][6].
documentation site](http://docs.syncthing.net/).
All code is licensed under the All code is licensed under the [MPLv2 License][7].
[MPLv2 License](https://github.com/syncthing/syncthing/blob/master/LICENSE).
[1]: https://github.com/syncthing/specs/blob/master/BEPv1.md
[2]: http://docs.syncthing.net/intro/getting-started.html
[3]: https://github.com/syncthing/syncthing/blob/master/etc
[4]: https://webchat.freenode.net/
[5]: http://docs.syncthing.net/dev/building.html
[6]: http://docs.syncthing.net/
[7]: https://github.com/syncthing/syncthing/blob/master/LICENSE