Changeset 920

Show
Ignore:
Timestamp:
07/30/08 00:26:56 (16 months ago)
Author:
bsmith
Message:

Updating README.txt

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/Vanilla/README.txt

    r675 r920  
    1 ############################################################# 
    2 This is a placeholder README. 
    3 If you are the author, please fill in the __sections__ below. 
    4 If you are not the author, please bug the author. 
    5 ############################################################# 
     1## Vanila, a plugin for Movable Type 
     2## Author: Beau Smith, beau at sixapart com 
     3## Version: 0.1 
     4## Released under GPL 
    65 
    7 ## __PLUGINNAME__, a plugin for Movable Type 
    8 ## Author: __AUTHORNAME__, __EMAIL/URL__ 
    9 ## Version: __VERSION__ 
    10 ## Released under __LICENSE__ 
    11 ## 
    12 ## $Id$ 
    13   
    146## OVERVIEW ## 
    157 
    16 __A short and very basic description of the plugin.__ 
     8    A series of template sets to learn about specific features in Movable Type. 
    179 
    1810## PREREQUISITES ## 
    1911 
    20 __detail MT version compatibility and anything else the plugin requires__ 
     12    Requires Movable Type 4.2 for most features. 
    2113 
    2214## FEATURES ## 
    2315 
    24 __A longer description of the plugin's features for those who are still reading__ 
     16    Template Sets 
     17 
     18    1. Vanilla 
     19        - Lastn entries on Homepage 
     20        - Entry Detail 
     21 
     22    2. Vanilla + Archives 
     23        - Base homepage & entries 
     24        - Archive Index 
     25        - Archives: Monthly, Author, Category and Category-Monthly 
     26        - Navigation w/ Category-Monthly links on Category Archives 
     27 
     28    3. Vanilla + Pages 
     29        - Base homepage & entries 
     30        - Pages 
     31        - Navigation including Pages 
     32 
     33    4. Vanilla + Authentication & Userpics 
     34        - En/disable userpics in javascript 
     35        - Use of community "edit profile" script is necessary to add userpics. The "edit profile" page assumes that you are using profiles and thus links to "view profile" screen. If using profiles is not desired, the "view profile" link can be removed from the "Profile Edit" Global System Template. 
     36 
     37    5. Vanilla + Comments 
     38        - Authentication 
     39        - Comments 
     40        - Comment reply links 
     41        - Comment Preview 
     42        - Comment Response 
     43 
     44    6. Vanilla + Comments w/ Userpics 
     45        - Authentication w/ userpic 
     46        - Comments w/ userpics 
     47        - Comment reply links 
     48        - Comment Preview 
     49        - Comment Response 
     50        - En/disable userpics in javascript 
     51        - Use of community "edit profile" script is necessary to add userpics. The "edit profile" page assumes that you are using profiles and thus links to "view profile" screen. If using profiles is not desired, the "view profile" link can be removed from the "Profile Edit" Global System Template. 
     52 
     53    7. Vanilla + Create Entry 
     54        - Authentication 
     55        - Create Entry 
     56        - Entry Response 
    2557 
    2658## INSTALLATION ## 
    2759 
    28 __detail installation instructions__ 
     60    Place the Vanilla plugin folder in the MT plugins folder 
    2961 
    30 ## CONFIGURATION ## 
    31  
    32 __detail configuration instructions, if any__ 
     62        $MT_DIR/ 
     63            plugins/ 
     64                Vanilla 
    3365 
    3466## USAGE ## 
    3567 
    36 __detail further usage instructions, if any__ 
     68    Install template sets in two ways: 
     69 
     70    1. When creating a new blog, select the template set you wish to use 
     71    2. Go to Design > Templates and select the "Refresh Templates" action link in the sidebar and choose the template set you wish to install 
    3772 
    3873## KNOWN ISSUES ## 
    3974 
    40 __detail any known issues with current version, if any__ 
     75    Any issues with each template set are listed under each template set in the Features section above. 
    4176 
    4277## SUPPORT ## 
    4378 
    44 __specify where people can go for support__ 
     79    There is no official support for this plugin, but you may email <beau at sixapart com> and/or mtos-dev@sixapart.com for assistance. 
    4580 
    4681## SOURCE CODE ## 
    4782 
    48 Source 
     83    Source 
    4984 
    50 SVN Repo: 
    51     http://code.sixapart.com/svn/mtplugins/trunk/__PLUGINNAME__ 
     85    SVN Repo: 
     86    http://code.sixapart.com/svn/mtplugins/trunk/Vanilla 
    5287 
    53 Trac View: 
    54     http://code.sixapart.com/trac/mtplugins/log/trunk/__PLUGINNAME_ 
     88    Trac View: 
     89    http://code.sixapart.com/trac/mtplugins/browser/trunk/Vanilla 
    5590 
    56 Plugins: 
    57     http://plugins.movabletype.org/__PLUGIN__ 
     91    Plugins: 
     92    http://plugins.movabletype.org/Vanilla (Not Yet Available) 
    5893 
    5994 
    6095## LICENSE ## 
    6196 
    62 __specify the license the plugin is released under__ 
     97    GPL 
    6398 
    6499## AUTHOR ## 
    65100 
    66 __insert arbitrary author info, e.g name, email, URL, company, etc__ 
     101    Beau Smith <beau at sixapart com> http://beausmith.com/