From 97aac6aa3f960464a783d194266d994515f4ffe9 Mon Sep 17 00:00:00 2001 From: Vincent Driessen Date: Thu, 19 Aug 2010 00:16:01 +0200 Subject: Add a simple tutorial. --- tutorial.rst | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 tutorial.rst diff --git a/tutorial.rst b/tutorial.rst new file mode 100644 index 0000000..a7fe4a2 --- /dev/null +++ b/tutorial.rst @@ -0,0 +1,54 @@ +Simple example +============== +Set your cursor inside the following paragraph and type ",,c": + +Feature Description +Easy It's soo easy, man. +Predictable Amount of spaces doesn't matter. +Repeatable It can be repeated. + +Then, the paragraph should turn into: + ++=============+==================================+ +| Feature | Description | ++=============+==================================+ +| Easy | It's soo easy, man. | ++-------------+----------------------------------+ +| Predictable | Amount of spaces doesn't matter. | ++-------------+----------------------------------+ +| Repeatable | It can be repeated. | ++-------------+----------------------------------+ + +Then, fix the "soo" to become "so" and insert the word "really" between +"doesn't" and "matter". Finally, rename "Easy" to "Super easy", so it looks +like this: + ++=============+==================================+ +| Feature | Description | ++=============+==================================+ +| Super easy | It's so easy, man. | ++-------------+----------------------------------+ +| Predictable | Amount of spaces doesn't really matter. | ++-------------+----------------------------------+ +| Repeatable | It can be repeated. | ++-------------+----------------------------------+ + +Then, set your cursor inside the table again, and type ,,f to reformat the +table. + + +A more complex example +====================== +|Feature| Description | +Ease of use | Drop dead simple! +Foo | Bar, qux, mux +Predictability | Deploykdj sfkljsdjf ljdflsk jsdflkj dsflkj sdlkj dfslkj + | dfslkjds flkdjsfl sdfjlk jdfslk djsfl dfjslk jsdflk jfdslk jdfslkds fjlkds + | jldkfj ldfsjlsd jldsf jlkjds flds fjlk jdflk jdsflj dslfjs dlfj sdflkj sdlfj + |dfslkjds flkdjsfl sdfjlk jdfslk djsfl dfjslk jsdflk jfdslk jdfslkds fjlkds + |jldkfj ldfsjlsd jldsf jlkjds flds fjlk jdflk jdsflj dslfjs dlfj sdflkj sdlfj + |dfslkjds flkdjsfl sdfjlk jdfslk djsfl dfjslk jsdflk jfdslk jdfslkds fjlkds + |jldkfj ldfsjlsd jldsf jlkjds flds fjlk jdflk jdsflj dslfjs dlfj sdflkj sdlfj + |ldfsj dlfsj dfskjdfs ldsfj + +And some para-text below it. -- cgit v1.2.3