diff options
| author | Siddharth Ravikumar <sravik@bgsu.edu> | 2015-12-22 15:21:13 -0500 |
|---|---|---|
| committer | Siddharth Ravikumar <sravik@bgsu.edu> | 2015-12-22 15:21:13 -0500 |
| commit | 9c9988f28a8a0efb444a63827476b16fdf3cfa10 (patch) | |
| tree | cc1c82acadd6b299b525cedfb1dabc3d9a7364ba /README.rst | |
| parent | 22335fc4e71de5c4ceefbd5e502a15ad285740cf (diff) | |
Added docs/ (uses sphinx).
Most of what was in README.rst was moved to docs/
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 83 |
1 files changed, 4 insertions, 79 deletions
@@ -2,13 +2,13 @@ combox ====== +.. highlight:: bash + 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 @@ -34,81 +34,6 @@ runs on - 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 ------- @@ -118,12 +43,12 @@ 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`__. +The ``combox`` logo is under `Public Domain`__. .. _pd: https://creativecommons.org/publicdomain/zero/1.0/ .. __: pd_ + contact ------- |