Skip to content

Commit

Permalink
Added a little more documentation 📖
Browse files Browse the repository at this point in the history
  • Loading branch information
adiultra committed May 25, 2016
1 parent 897661b commit 263778f
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 18 deletions.
7 changes: 6 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
========
Index
========

Welcome to TodX's documentation!
================================

Expand All @@ -7,12 +11,13 @@ TodX is a simple and to the point ToDo list app which enhances productivity and


Contents
=========
--------

.. toctree::
:maxdepth: 2

userguide
list

Features

Expand Down
8 changes: 8 additions & 0 deletions docs/list.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Lists
=====

Lists are the collection of similar ToDos that are grouped together. Every List has a **Title**, A group of **Tags** (*Optional*) and a list of ToDo's.

During Creation, You can specify the Title(mandatory) and Tags(optional). When Created a list can be opened by using ``open`` command.

To add a new ToDo to an *open* List, use the ``append`` command.
52 changes: 35 additions & 17 deletions docs/userguide.rst
Original file line number Diff line number Diff line change
@@ -1,25 +1,43 @@
==========
User Guide
=========
==========

> This guide helps to provide a extended documentation for using the app.
> For development please check [development](development.md)
This guide helps to provide a extended documentation for using the app.
For development please check [development](development.md)

Data Concepts
-------------

.. toctree::
:maxdepth: 2

list

Entry Modes
======= ============= =============
Command Usual Meaning Answer Format
======= ============= =============
`*>` Basic commands commands like `open` etc
`+>` Entry or Input for Content String text or one word
`#>` Usually index of Lists etc Numbers
`?>` Question Input yes/no
======= ============= =============
-----------

======= =========================== ==========================
Command Usual Meaning Answer Format
======= =========================== ==========================
``*>`` Basic commands commands like ``open`` etc
``+>`` Entry or Input for Content String text or one word
``#>`` Usually index of Lists etc Numbers
``?>`` Question Input yes/no
======= =========================== ==========================

Basic Commands
--------------

- New
**Command** : ``new`` or ``n``

**Function** : Create a new Todo List

When executed it Asks for Title and Tags(optional)

- Open
**Command** : ``open`` or ``o``

- ### New
**Command** : `new` or `n`
**Function** : Create a new Todo List
**Function** : Open a Todo list from the available options.

- ### Open
**Command** : `open` or `o`
**Function** : Open a Todo list from the available options.
Open A new Note List to do further editing. When Executed it asks for the index of the list you want to open. If There is no list present then It tells you to create a new one.

0 comments on commit 263778f

Please sign in to comment.