mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 16:48:31 +02:00
c5729420a4
* Update authors to "jrnl contributors" to comply with GPL3 * Include jrnl email address with contributors * Include GPL notice in jrnl --version * Apply consistent copyright and license to all Python files * Add copyright and license to documentation * Add copyright and license to docs theme * Wiping poetry cache to try to resolve a test issue * Testing with Python 3.9.0 in attempt to bypass GitHub Actions failure in 3.9.1 * make format * Exclude Windows Python 3.9 build which is failing due to a GitHub Actions problem * Modify testing to get around this 3.9 issue... * Fix exclude
42 lines
1.2 KiB
Markdown
42 lines
1.2 KiB
Markdown
<!-- Copyright (C) 2012-2021 jrnl contributors
|
|
License: https://www.gnu.org/licenses/gpl-3.0.html -->
|
|
# Getting started
|
|
|
|
## Installation
|
|
|
|
On Mac and Linux, the easiest way to install `jrnl` is using
|
|
[Homebrew](http://brew.sh/):
|
|
|
|
``` sh
|
|
brew install jrnl
|
|
```
|
|
|
|
On other platforms, install `jrnl` using [Python](https://www.python.org/) 3.6+ and [pipx](https://pipxproject.github.io/pipx/):
|
|
|
|
``` sh
|
|
pipx 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
|
|
|
|
``` text
|
|
jrnl yesterday: Called in sick. Used the time to clean, and spent 4h on writing my book.
|
|
```
|
|
|
|
and hit return. `yesterday:` will be interpreted as a time stamp.
|
|
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:
|
|
|
|
``` output
|
|
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](advanced.md) *jrnl* to use your external editor.
|