-
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.
Added a little Documentation :paper:
- Loading branch information
Showing
4 changed files
with
40 additions
and
233 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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 @@ | ||
# Developer's Guide |
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,5 +1,19 @@ | ||
#Welcome to Todx's documentation! | ||
Todx Is a great Command line app that is so waesome that you'll fall in hate woith it. :smile: | ||
# Welcome to Todx's documentation! | ||
|
||
#### The Stupid Simple Plain ToDo List App | ||
|
||
TodX is a simple and to the point ToDo list app which enhances productivity and doesn't come in between you. | ||
|
||
## Features : | ||
|
||
- Fast | ||
- Simple | ||
- Inituitive | ||
- Easy to Use | ||
- Offline | ||
- Open Source | ||
|
||
|
||
|
||
### Contents: | ||
- [User Guide](userguide.md) |
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 +1,23 @@ | ||
#User Guide | ||
# User Guide | ||
|
||
> This guide helps to provide a extended documentation for using the app. | ||
> For development please check [development](development.md) | ||
## Entry Modes | ||
|
||
|Command | Usual Meaning | Answer Format | | ||
|---------|---------|---------| | ||
| `*>` | Basic commands | commands like `open` etc | | ||
| `+>` | Entry or Input for Content | String text or one word | | ||
| `#>` | Numeric Entry usually index of Lists etc | Numbers | | ||
| `?>` | Question Input | yes/no | | ||
|
||
## Basic Commands | ||
|
||
- ### New | ||
**Command** : `new` or `n` | ||
**Function** : Create a new Todo List | ||
|
||
- ### Open | ||
**Command** : `open` or `o` | ||
**Function** : Open a Todo list from the available options. |