summaryrefslogblamecommitdiffstats
path: root/README.rst
blob: a8c8c6513003d9ac94f1749d75e1bb45d7a63a20 (plain) (tree) 
95f31e2


































































































































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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130


































































































































                                                                                               
======
combox
======

Encrypts files and scatters them across storage provided by Google
Drive and Dropbox.

The ideas for this program is based on combobox_

Homepage at <https://ricketyspace.net/combox>

.. _combobox: https://bitbucket.org/bgsucodeloverslab/combobox


etymology
---------

``combox`` is a lazy contraction of the word "combo box". ``combox``
is pronounced as "combo box".


canonical repo
--------------

::

   $ git clone git://ricketyspace.net/combox.git


runs on
-------

 - GNU/Linux
 - OS X


using combox
------------

on gnu/linux
============

Install ``virtualenv`` and python dev. package.

On a Debian based distribution, do::

    # aptitude install virtualenv python-dev

on os x
=======

First install Hombrew_::

    $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

.. _Hombrew:  http://brew.sh/

Then do::

    $ brew update
    $ brew doctor

Next, install python from Hombrew_::

    $ brew install python

This will also install ``pip``.

Lastly do::

    $ pip install virtualenv

set up combox
=============

Get the latest copy of combox::

    $ git clone git://ricketyspace.net/combox.git

Setup virtual environment::

    $ cd combox
    $ virtualenv .

Activate the virtual environment::

    $ source bin/activate

Install combox::

    $ python setup.py install

Run combox::

    $ combox

Always make sure that the virtual environment is activated before
running combox. To activate virtual environment, do::

    $ cd path/to/combox
    $ source bin/activate


combox on windows
-----------------

At the moment, combox is not compatible with Windows. If you can make
combox work on Windows, look at
<https://ricketyspace.net/combox/windows/> for info on setting up the
development environment on Windows.

license
-------

``combox`` is licensed under the `GNU General Public License version 3
or later`__. See COPYING.

.. _gpl: https://gnu.org/licenses/gpl-3.0.txt
.. __: gpl_

The ``combox`` logo (``graphics/logo/combox-logo.svg``) is under
`Public Domain`__.

.. _pd: https://creativecommons.org/publicdomain/zero/1.0/
.. __: pd_

contact
-------

siddharth ravikumar <sravik@bgsu.edu> (gpg id: ``0x00B252AF``)
siddharth ravikumar snafu