Skip to content

Commit

Permalink
Added a little Documentation :paper:
Browse files Browse the repository at this point in the history
  • Loading branch information
adiultra committed May 25, 2016
1 parent f0ed3ca commit 85359d1
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 233 deletions.
230 changes: 0 additions & 230 deletions docs/Makefile

This file was deleted.

1 change: 1 addition & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Developer's Guide
18 changes: 16 additions & 2 deletions docs/index.md
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)
24 changes: 23 additions & 1 deletion docs/userguide.md
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.

0 comments on commit 85359d1

Please sign in to comment.