-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/Blarfnip/JRNL
- Loading branch information
Showing
1 changed file
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# JRNL | ||
#### A Simple Journaling Software for Keeping Track of Daily Thoughts | ||
|
||
Inspired by [@dittomat's](https://twitter.com/dittomat) journaling app which took inspiration from | ||
[@SimoneGiertz's](https://twitter.com/simonegiertz?lang=en) amazing calendar, this is my spin on the idea. The original prototype was built | ||
in a week with the goal of having a very simple way of consolidating my daily thoughts. | ||
|
||
![Early Gif](/Ver1.gif) | ||
|
||
All jrnl entries are saved in `/Documents/jrnl Entries` as `.jrnl` files. These files are markdown files that can be opened and read | ||
in any other markdown editor. | ||
|
||
jrnl tries its hardest to save your entries as much as it can. It will save automatically when you switch to viewing another entry | ||
and when you quit (by pressing `Esc`). But if that isn't enough for you, `Ctrl/Cmd+S` will manually save the entry as well. | ||
|
||
Upon opening jrnl it will automatically open up the day's entry. If an entry does not exist it will make one. | ||
|
||
#### Renaming `.jrnl` files will cause jrnl to lose track of them | ||
|
||
## Installing | ||
### For Personal Use | ||
Download the applicable folder from the **releases** folder in this repo and run the executable. | ||
|
||
### For Development | ||
This project is built with Node.js and Electron. To develop for this have Node.js installed and do the following: | ||
1. Clone the repo | ||
2. navigate to **application** folder in a terminal | ||
3. run `npm install` | ||
4. run `npm start` to open application | ||
|
||
#### To build an executable | ||
Use [epi](https://github.com/Urucas/electron-packager-interactive) to build the electron app into an executable. | ||
|
||
## Like what I do? | ||
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/T6T1TDCS) |