-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
49 additions
and
18 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
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,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. |
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 |
---|---|---|
@@ -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. |