Fixes typos in readme

This commit is contained in:
Manuel Ebert 2013-03-13 00:51:17 -07:00
parent fb94c816f7
commit 165d9b2d8d
2 changed files with 22 additions and 12 deletions

2
.gitignore vendored
View file

@ -20,3 +20,5 @@ lib64
# Installer logs # Installer logs
pip-log.txt pip-log.txt
.DS_Store

View file

@ -20,7 +20,7 @@ to make a new entry, just type
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: 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. 2012-03-29 09:00 Called in sick.
Used the time to clean the house and spent 4h on writing my book. 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. If you just call `jrnl`, you will be prompted to compose your entry - but you can also configure _jrnl_ to use your external editor.
@ -44,15 +44,15 @@ The first time you run `jrnl` you will be asked where your journal file should b
Usage Usage
----- -----
_jrnl_ has to modes: __composing__ and __viewing__. _jrnl_ has to modes: __composing__ and __viewing__.
### Viewing: ### Viewing:
jrnl -n 10 jrnl -n 10
will list you the ten latest entries, will list you the ten latest entries,
jrnl -from "last year" -to march jrnl -from "last year" -to march
everything that happened from the start of last year to the start of last march. If you only want to see the titles of your entries, use everything that happened from the start of last year to the start of last march. If you only want to see the titles of your entries, use
@ -62,7 +62,7 @@ everything that happened from the start of last year to the start of last march.
Keep track of people, projects or locations, by tagging them with an `@` in your entries: Keep track of people, projects or locations, by tagging them with an `@` in your entries:
jrnl Had a wonderful day on the #beach with @Tom and @Anna. jrnl Had a wonderful day on the @beach with @Tom and @Anna.
You can filter your journal entries just like this: You can filter your journal entries just like this:
@ -74,7 +74,14 @@ Will print all entries in which either `@pinkie` or `@WorldDomination` occurred.
the last five entries containing both `@pineapple` __and__ `@lubricant`. You can change which symbols you'd like to use for tagging in the configuration. the last five entries containing both `@pineapple` __and__ `@lubricant`. You can change which symbols you'd like to use for tagging in the configuration.
> __Note:__ `jrnl @pinkie @WorldDomination` will switch to viewing mode because although now command line arguments are given, all the input strings look like tags - _jrnl_ will assume you want to filter by tag. > __Note:__ `jrnl @pinkie @WorldDomination` will switch to viewing mode because although _no_ command line arguments are given, all the input strings look like tags - _jrnl_ will assume you want to filter by tag.
### Composing:
Composing mode is entered by either starting `jrnl` without any arguments -- which will prompt you to write an entry or launch your editor -- or by just writing an entry on the prompt, such as
jrnl today at 3am: I just met Steve Buscemi in a bar! He looked funny.
### Smart timestamps: ### Smart timestamps:
@ -143,17 +150,17 @@ The configuration file is a simple JSON file with the following options.
- `tagsymbols`: Symbols to be interpreted as tags. (__See note below__) - `tagsymbols`: Symbols to be interpreted as tags. (__See note below__)
- `default_hour` and `default_minute`: if you supply a date, such as `last thursday`, but no specific time, the entry will be created at this time - `default_hour` and `default_minute`: if you supply a date, such as `last thursday`, but no specific time, the entry will be created at this time
- `timeformat`: how to format the timestamps in your journal, see the [python docs](http://docs.python.org/library/time.html#time.strftime) for reference - `timeformat`: how to format the timestamps in your journal, see the [python docs](http://docs.python.org/library/time.html#time.strftime) for reference
- `highlight`: if `true` and you have [clint](http://www.nicosphere.net/clint-command-line-library-for-python/) installed, tags will be highlighted in cyan. - `highlight`: if `true` and you have [clint](http://www.nicosphere.net/clint-command-line-library-for-python/) installed, tags will be highlighted in cyan.
- `linewrap`: controls the width of the output. Set to `0` or `false` if you don't want to wrap long lines. - `linewrap`: controls the width of the output. Set to `0` or `false` if you don't want to wrap long lines.
> __Note on `tagsymbols`:__ Although it seems intuitive to use the `#` character for tags, there's a drawback: on most shells, this is interpreted as a meta-character starting a comment. This means that if you type > __Note on `tagsymbols`:__ Although it seems intuitive to use the `#` character for tags, there's a drawback: on most shells, this is interpreted as a meta-character starting a comment. This means that if you type
> >
> jrnl Implemented endless scrolling on the #frontend of our website. > jrnl Implemented endless scrolling on the #frontend of our website.
> >
> your bash will chop off everything after the `#` before passing it to _jrnl_). To avoid this, wrap your input into quotation marks like this: > your bash will chop off everything after the `#` before passing it to _jrnl_). To avoid this, wrap your input into quotation marks like this:
> >
> jrnl "Implemented endless scrolling on the #frontend of our website." > jrnl "Implemented endless scrolling on the #frontend of our website."
> >
> Or use the built-in prompt or an external editor to compose your entries. > Or use the built-in prompt or an external editor to compose your entries.
### DayOne Integration ### DayOne Integration
@ -177,14 +184,15 @@ You can configure _jrnl_ to use with multiple journals (eg. `private` and `work`
"work": "~/work.txt" "work": "~/work.txt"
}, },
The `default` journal gets created the first time you start _jrnl_. Now you can access the `work` journal by using `jrnl work` instead of `jrnl`, eg. The `default` journal gets created the first time you start _jrnl_. Now you can access the `work` journal by using `jrnl work` instead of `jrnl`, eg.
jrnl work at 10am: Meeting with @Steve jrnl work at 10am: Meeting with @Steve
jrnl work -n 3 jrnl work -n 3
will both use `~/work.txt`, while `jrnl -n 3` will display the last three entries from `~/journal.txt` (and so does `jrnl default -n 3`). will both use `~/work.txt`, while `jrnl -n 3` will display the last three entries from `~/journal.txt` (and so does `jrnl default -n 3`).
You can also override the default options for each individual journal. If you `.jrnl_conf` looks like this: You can also override the default options for each individual journal. If you `.jrnl_conf` looks like this:
{ {
... ...
"encrypt": false "encrypt": false