fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-07-01 22:56:12 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated Readme from master

Browse source
This commit is contained in:
Manuel Ebert 2012-04-16 14:16:31 +02:00
parent 53bb7ae872
commit 7c5b42ec9b
2 changed files with 41 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -1,12 +1,15 @@
# jrnl
jrnl
====
*jrnl* is a simple journal application for your command line. Journals are stored as human readable plain text files - you can put them into a Dropbox folder for instant syncinc and you can be assured that your journal will still be readable in 2050, when all your fancy iPad journal applications will long be forgotten.
## Why keep a journal?
Why keep a journal?
-------------------
Journals aren't only for 13-year old girls and people who have too much time on their summer vacation. A journal helps you to keep track of the things you get done and how you did them. Your imagination may be limitless, but your memory isn't. For personal use, make it a good habit to write at least 20 words a day. Just to reflect what made this day special, why you haven't wasted it. For professional use, consider a text-based journal to be the perfect complement to your GTD todo list - a documentation of what and how you've done it.
## How to use?
How to use?
-----------
to make a new entry, just type
@ -25,7 +28,7 @@ If we start our entry by e.g. `yesterday:` or `last week monday at 9am:` the ent
### Viewing:
jrnl -10
jrnl -n 10
will list you the ten latest entries,
@ -68,11 +71,25 @@ Can do:
jrnl -json
## Installation
Installation
------------
...
You can install _jrnl_ manually by cloning the repository:
## Advanced configuration
git clone git://github.com/maebert/jrnl.git
cd jrnl
python setup.py install
or by using pip:
pip install jrnl
Afterwards, you may want to create an alias in your `.bashrc` or `.bash_profile` or whatever floats your shell:
alias jrnl="jrnl.py"
Advanced configuration
----------------------
The first time launched, _jrnl_ will create a file called `.jrnl_config` in your home directory. It's just a regular `json` file:

19
index.html
View file

@ -90,7 +90,7 @@ Used the time to clean the house and spent 4h on writing my book.
<h3>Viewing:</h3>
<pre><code>jrnl -10
<pre><code>jrnl -n 10
</code></pre>
<p>will list you the ten latest entries,</p>
@ -142,7 +142,22 @@ Used the time to clean the house and spent 4h on writing my book.
<h2>Installation</h2>
<p>...</p>
<p>You can install <em>jrnl</em> manually by cloning the repository:</p>
<pre><code>git clone git://github.com/maebert/jrnl.git
cd jrnl
python setup.py install
</code></pre>
<p>or by using pip:</p>
<pre><code>pip install jrnl
</code></pre>
<p>Afterwards, you may want to create an alias in your <code>.bashrc</code> or <code>.bash_profile</code> or whatever floats your shell:</p>
<pre><code>alias jrnl="jrnl.py"
</code></pre>
<h2>Advanced configuration</h2>