README.rst 2.36 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
ring-project
============

This repository is the master repository for Ring. It contains a build script, make-ring.py,
that can be used to build and install ring from source on different platforms.

More documentation can be found on http://docs.ring.cx. You may also build the documentation
with ``make docs``. The documentation will be built in ``docs/build/html``.

Using make-ring
###############

Dependencies
------------

The Ring installer uses python3. Please make sure it is installed before running it.

Initialize the repositories
---------------------------

.. code-block:: bash

    ./make-ring.py --init

On Linux
--------

1. Build and install all the dependencies:

.. code-block:: bash

    ./make-ring.py --dependencies

Your distribution's package manager will be used.

2. Build and install locally under this repository:

.. code-block:: bash

    ./make-ring.py --install

3. Run daemon and client that were installed locally:

.. code-block:: bash

	./make-ring.py --run

You can then stop the processes with CTRL-C.

You can also run them in the background with the ``--background`` argument and then use the ``--stop`` command to stop them. Stdout and stderr go to daemon.log and client-gnome.log.

Install globally for all users instead
''''''''''''''''''''''''''''''''''''''

.. code-block:: bash

    ./make-ring.py --install --global-install

Run global install:

.. code-block:: bash

    gnome-ring

This already starts the daemon automatically for us.

Uninstall the global install:

.. code-block:: bash

    ./make-ring.py --uninstall

On OSX
------

You need to setup Homebrew (<http://brew.sh/>) since their is no built-in package manager on OSX.

Build and install all the dependencies:

.. code-block:: bash

    ./make-ring.py --dependencies


Build and install locally under this repository:

.. code-block:: bash

    ./make-ring.py --install

Output
''''''

You can find the .app file in the ``./install/client-macosx`` folder.

On Android
----------

Please make sure you have the Android SDK and NDK installed, and that their paths are properly set. For further information, please visit <https://github.com/savoirfairelinux/ring-client-android>

Build and install locally under this repository:

.. code-block:: bash

    ./make-ring.py --install --distribution=Android

Output
''''''

You can find the .apk file in the ./client-android/ring-android/app/build/outputs