Skip to content

Commit 854ff97

Browse files
author
Robert Whitaker
committed
Added a README.
1 parent f4556d4 commit 854ff97

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Elm-Planner
2+
A recursive planner application written in [Elm](http://elm-lang.org).
3+
4+
Just want to use it? [Try it out now!](http://robwhitaker.github.io/Elm-Planner)
5+
6+
## Features
7+
* Take notes in a tree-hierarchy, allowing each node to have sub-nodes down to any depth.
8+
* Each node can be titled and can store text content of its own (including nodes with children).
9+
* Autosave as you go! Every change you make is automatically saved to localstorage.
10+
* Save projects to or load project from your local machine. Working from multiple computers or browsers? Save the file, transfer it to your other machine, and upload it right back into Elm Planner!
11+
12+
## Building Locally
13+
14+
This is assuming you have Elm v0.15+ installed already. If not, get it [here](http://elm-lang.org).
15+
16+
1. Clone this repository.
17+
2. In terminal:
18+
```
19+
$ cd PATH_TO_ELM_PLANNER
20+
21+
$ elm-package install -y
22+
23+
$ ./make && elm reactor
24+
```
25+
3. Open `localhost:8000/index.html` in your browser.

0 commit comments

Comments
 (0)