ca73c74a8e
* Extensive modifications to overview.md. I tried to add clarity and details while maintaining the spirit of the original document. However, it might be a bit too 'dry' now. I'd be happy to liven it up a bit. I'm only serious when I feel like I _have_ to be. One of my opinions (which may be at odds with yours) is that the documentation should emphasize `jrnl`'s advantages without downplaying any other existing solutions. If I have time, I'd like to add more information about the documented benefits of journaling, particularly the mental health aspects. That will probably need its own page, but I'm new here, so I don't want to overstay my welcome. :) * More changes to overview.md in response to feedback "why keep a journal" section removed -- it could be re-added as its own page, but it's not front-page material * More changes to overview.md: - fixed up the headings - added information about multi-platform support This is a work in progress and _not_ ready for prime-time. - need to add to Command-Line Interface section, among other things * More changes to overview.md: - moved "`jrnl` is a simple..." to "Command-Line Interface" section |
||
|---|---|---|
| .build | ||
| .github | ||
| docs | ||
| features | ||
| jrnl | ||
| .gitattributes | ||
| .github_changelog_generator | ||
| .gitignore | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| issue_template.md | ||
| LICENSE.md | ||
| Makefile | ||
| mkdocs.yml | ||
| poetry.lock | ||
| pyproject.toml | ||
| README.md | ||
jrnl 
To get help, submit an issue on Github.
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 syncing 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.
Optionally, your journal can be encrypted using the 256-bit AES.
Why keep a journal?
Journals aren't just for 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, or 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.
In a Nutshell
To make a new entry, just type
jrnl yesterday: Called in sick. Used the time cleaning the house and 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 cleaning the house and 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.
For more information, please read our documentation.
Contributors
Maintainers
Our maintainers help keep the lights on for the project. Please thank them if you like jrnl.
- Jonathan Wren (wren)
- Micah Ellison (micahellison)
Code Contributors
This project is made with love by the many fabulous people who have contributed. Jrnl couldn't exist without each and every one of you!
If you'd also like to help make jrnl better, please see our contributing documentation.
Financial Backers
Another way show support is through direct financial contributions. These funds go to covering our costs, and are a quick way to show your appreciation for jrnl.
Become a financial contributor and help us sustain our community.
