fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-06-28 13:36:14 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Doc stubs

Browse source
This commit is contained in:
Manuel Ebert 2013-08-22 15:46:09 -07:00
parent cc6fdf09ec
commit acb69a472d
67 changed files with 9087 additions and 3705 deletions
Download patch file Download diff file Expand all files Collapse all files

39
docs/installation.rst Normal file
View file

@ -0,0 +1,39 @@
.. _download:
Getting started
===============
Installation
------------
Install *jrnl_* using pip ::
pip install jrnl
Or, if you want the option to encrypt your journal, ::
pip install jrnl[encrypted]
To install the dependencies for encrypting journals as well
.. note::
Installing the encryption library, `pycrypto`, requires a `gcc` compiler. You can also `install PyCyrypto manually <https://www.dlitz.net/software/pycrypto/>`_ first.
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::
jrnl yesterday: Called in sick. Used the time to clean the house anspent 4h on writing my book.
and hit return. `yesterday:` will be interpreted as a timestamp. Everything until the first sentence mark (`.?!`) will be interpreted as the title, the rest as the body. In your journal file, the result will look like this:::
2012-03-29 09:00 Called in sick.
Used the time to clean the house and spent 4h on writing my book.
If you just call ``jrnl``, you will be prompted to compose your entry - but you can also configure *jrnl* to use your external editor.