Skip to content

Commit

Permalink
Merge pull request #83 from epayet/readme-contributing
Browse files Browse the repository at this point in the history
Add Contributing section to readme
  • Loading branch information
MichaelAquilina committed Oct 29, 2017
2 parents cd0b9da + 94e7004 commit cec2bef
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ The easiest way to install S4 is through pip:

$ pip install s4

You will need ``libmagic`` installed.
This is installed by default on most linux distributions but on MacOSX you need to install it with brew as follows:

::

brew install libmagic

Setup
-----
Expand Down Expand Up @@ -121,7 +127,7 @@ Some other subcommands that you could find useful:
Use the ``--help`` parameter on each subcommand to get more details.

How S4 Works
-------------
------------

S4 keeps track of changes between files with a ``.index`` file at
the root of each folder you are syncing. This contains the keys of each
Expand Down Expand Up @@ -172,6 +178,26 @@ Here are is a list of open source solutions that I have tried in the past.

* ``duplicity``: great backup tool, but does not provide a sync solution of any kind.

Contributing
------------

Pull requests are welcome! Make sure you pass all the tests, Travis will tell you if you don't ;)

Running locally
```````````````

``tox`` is used to run the tests locally:

::
pip install tox

And then to run the tests locally:

::

tox

.. |TravisCI| image:: https://travis-ci.org/MichaelAquilina/S4.svg?branch=master
:target: https://travis-ci.org/MichaelAquilina/S4

Expand Down

0 comments on commit cec2bef

Please sign in to comment.