Merge branch 'master-wm' into 2.0-wm

This commit is contained in:
MinchinWeb 2018-04-07 19:56:48 -06:00
commit b3e614f441
26 changed files with 313 additions and 79 deletions

View file

@ -6,21 +6,46 @@ Getting started
Installation
------------
Install *jrnl* using pip ::
On OS X, the easiest way to install *jrnl* is using `Homebrew <http://brew.sh/>`_
.. code-block:: sh
brew install jrnl
On other platforms, install *jrnl* using pip
.. code-block:: sh
pip install jrnl
Or, if you want the option to encrypt your journal,
.. code-block:: sh
pip install jrnl[encrypted]
to install the dependencies for encrypting journals as well.
.. note::
Installing the encryption library, `pycrypto`, requires a `gcc` compiler. For this reason, jrnl will not install `pycrypto` unless explicitly told so like this. You can `install PyCrypto manually <https://www.dlitz.net/software/pycrypto/>`_ first or install it with ``pip install pycrypto`` if you have a `gcc` compiler.
Also note that when using zsh, the correct syntax is ``pip install "jrnl[encrypted]"`` (note the quotes).
Alternatively, on OS X with [Homebrew](http://brew.sh/) installed:
brew install jrnl
The first time you run ``jrnl`` you will be asked where your journal file should be created and whether you wish to encrypt it.
Quickstart
----------
to make a new entry, just type::
to make a new entry, just type
.. code-block:: sh
jrnl yesterday: Called in sick. Used the time to clean the house and spent 4h on writing my book.