Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 93 lines (53 sloc) 4.774 kB
940aaf2 Readme and license included.
Davis W. Frank authored
1 # Bulldog
73ee70b Added build badge to README; Another attempt to get correct exit code…
Davis W. Frank authored
2 ## An HTML viewer for Todo.Txt [![Build Status](https://secure.travis-ci.org/infews/bulldog.png?branch=master)](http://travis-ci.org/infews/bulldog)
940aaf2 Readme and license included.
Davis W. Frank authored
3
4 Be tenacious, like a bulldog, on your task list.
5
6 Bulldog is a single-page HTML view of your [todo.txt](http://http://todotxt.com/) file. Use the [command line interface](http://https://github.com/ginatrapani/todo.txt-cli/downloads) for capture, editing, and completing tasks. But if you want something a little bit more "app-y" for managing your tasks, Bulldog is for you.
7
ad37ebd Updating README with browser compatibility
Davis W. Frank authored
8 ## Browser Compatibility
9
10 * Safari 5+
11 * Chrome 9+
12 * Firefox - unsupported at this time (waiting on a bug fix)
13 * Others? Let us know
14
940aaf2 Readme and license included.
Davis W. Frank authored
15 ## Installation
16
ab08351 Removed an unused filel; Updated README with better installation inst…
Davis W. Frank authored
17 Bulldog is released as a single HTML file via the [Downloads page](http://github.com/infews/bulldog/downloads), called `index.html`, that needs to live in the same directory as your `todo.txt` file.
6ba8e5c Added installation instructions to README
Davis W. Frank authored
18
19 You will also need to set up a web server to point to this directory or configure your browser to allow AJAX requests from a `file://` URL. Bulldog makes an AJAX request to read in `todo.txt`
20
21 This isn't very user-friendly at this point in time.
22
ab08351 Removed an unused filel; Updated README with better installation inst…
Davis W. Frank authored
23 For these examples, I keep my `todo.txt` file (and all of my Todo.txt stuff) in `/Users/dwf/Dropbox/todo`.
24
25 ### Via HTTP and a Local Web Server
26
660a89f @jdevera Explain how to run Bulldog with an ad-hoc HTTP server
jdevera authored
27 #### Using Apache on MacOS
28
ab08351 Removed an unused filel; Updated README with better installation inst…
Davis W. Frank authored
29 These steps work on MacOS 10.7 (Lion), serving Bulldog via the built-in web server (Apache 2). Please look up the equivalent steps for your operating system and web server.
30
31 1. Make a symlink from Apache's directory to your ToDo.txt directory: `ln -s /Users/dwf/Dropbox/todo /Library/WebServer/Documents/todo`
32 1. Restart Apache by visiting the `Sharing` pane under `System Preferences`, and turning `Web Sharing` off (if it's on) and then on
33 1. Copy Bulldog's `index.html` to `/Users/dwf/Dropbox/todo`
34 1. Visit `http://localhost/todo`
35
660a89f @jdevera Explain how to run Bulldog with an ad-hoc HTTP server
jdevera authored
36 #### Using an Ad-hoc Web Server (Multiplatform)
37
38 An ad-hoc web server can be run with these steps if Python is installed (tested only on Linux but should work in other platforms):
39
40 1. _Cd_ into the directory containing `index.html` and `todo.txt`
41 1. Run `python -m SimpleHTTPServer`
42 1. Visit `http://localhost:8000/`
43
ab08351 Removed an unused filel; Updated README with better installation inst…
Davis W. Frank authored
44 ### Via the Local File Protocol
45
46 With some tweaking of your browser settings, `file://path/to/index.html` will work
47
48 * Safari: no change needed
49 * Firefox: enable "cross domain AJAX requests" via config settings; this differs across versions of Firefox, so you'll need to Google it
50 * Chrome/Chromium: launch the executable with the `--disable-web-security` flag set
51
940aaf2 Readme and license included.
Davis W. Frank authored
52 ## Usage
53
a5a3440 Refactor of HTML so there's one template for both dev & rel; Better c…
Davis W. Frank authored
54 Bulldog is a read-only view of your tasks. It is not meant as a replacement for the command line interface. Use the CLI for operations on tasks and then view the new state with Bulldog.
940aaf2 Readme and license included.
Davis W. Frank authored
55
56 When you open Bulldog, you see all of your tasks in the pane on the right. You should see each task's number, the action of the task, as well as its context and project. Contexts are set with the '@' syntax, and Projects with the '+' syntax.
57
305522a Adding Next Actions to the README
Davis W. Frank authored
58 The left column defaults to showing you all of your projects, including the 'All' project that shows all tasks, sorted by task number. Choosing a project will show all tasks for that project, sorted by priority. (No priority is lower than `Z`).
59
60 If you've updated or added any tasks via the command line, just reload your browser to refresh the tasks.
61
62 From the left column you can also choose to group tasks by context, or by next actions.
63
64 ### Next Actions
65
ad37ebd Updating README with browser compatibility
Davis W. Frank authored
66 Todo.txt has no built-in concept of [Getting Things Done's](http://www.davidco.com/about-gtd) next actions. So we added it. Setting a task to priority `N` makes it a next action - after all, why would you be using that many priorities? Next actions are labeled as such and are considered higher priority than `A`.
305522a Adding Next Actions to the README
Davis W. Frank authored
67
68 The next actions tab - labeled ➔ - shows only your next actions, grouped by context.
940aaf2 Readme and license included.
Davis W. Frank authored
69
70 ## Roadmap?
71
6ba8e5c Added installation instructions to README
Davis W. Frank authored
72 * Make it easier to install
305522a Adding Next Actions to the README
Davis W. Frank authored
73 * Support Dropbox installation (hosting via Dropbox's web UI, todo.txt on Dropbox)
ab08351 Removed an unused filel; Updated README with better installation inst…
Davis W. Frank authored
74 * Editing tasks & storing back to `todo.txt` - this would require a server, which may be out of scope
ad37ebd Updating README with browser compatibility
Davis W. Frank authored
75 * Show "DONE" actions, listed by interesting groupings
940aaf2 Readme and license included.
Davis W. Frank authored
76
77 ## Implementation
78
79 Bulldog is a single-page HTML application. It uses jQuery and Backbone.js (which means it also uses Underscore.js) to read in the todo.txt file via AJAX, build out local data objects (Backbone models & collections), and then display the tasks and UI.
80
ab08351 Removed an unused filel; Updated README with better installation inst…
Davis W. Frank authored
81 The base CSS and navigation UI are from Twitter's Bootstrap.
940aaf2 Readme and license included.
Davis W. Frank authored
82
83 All of the CSS and JavaScript is included inline so that no server is required.
84
85 ## Contributions
86
305522a Adding Next Actions to the README
Davis W. Frank authored
87 I welcome contributions and suggestions. Any code changes should include tests - naturally, using [Jasmine](http://pivotal.github.com/jasmine).
940aaf2 Readme and license included.
Davis W. Frank authored
88
89 ## License
90
91 Bulldog is © Infews LLC and is provided under the MIT License.
92
Something went wrong with that request. Please try again.