mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 08:38:32 +02:00
39 lines
1.2 KiB
ReStructuredText
39 lines
1.2 KiB
ReStructuredText
.. _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.
|
|
|