/[wryebash]/branches/upstream-dev/Mopy/Docs/Bash Readme Template.txt
ViewVC logotype

Contents of /branches/upstream-dev/Mopy/Docs/Bash Readme Template.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 4 - (show annotations) (download)
Mon Sep 19 03:20:26 2016 UTC (3 years, 4 months ago) by william
File MIME type: text/plain
File size: 6459 byte(s)
add upstream git branches for dev and master
1 == $modName ===================================================#
2 === Latest Version: ~~Link to preferred download site.~~
3 === Discussion: ~~Link to discussion forum~~
4 === Requirements:
5 ~~Optional. List of required mods other than Morrowind.esm. If anything other than the official expansions are required, give the details in [[#|Installation]].~~
6
7 == Contents ===================================================================
8 ~~You may want to cut this section out if your readme is very short. Also, you can make the contents deeper by setting CONTENTS to 2.~~
9 {{CONTENTS=1}}
10
11 == Overview ===================================================================
12 ~~This is where you talk about what your mod is/does. This should be fairly short (1-3 paragraphs). If you need more space, add more sections between [[#|Installation]] and [[#|Versions]].~~
13
14 == Installation ===============================================================
15 ~~Optional. It's now generally assumed that players know how to install mods. So this section is primarily useful for unusual install instructions.~~
16
17 == Versions ===================================================================
18 ~~Version notes go here.~~
19
20 === 0.01 Bugfix [1/21/2007]
21 * Fixed global thermonuclear destruction bug. My bad.
22
23 === 0.00 Initial Release [1/21/2007]
24 * Yay! Finally got it out the door!
25
26 == Syntax =====================================================================
27 ~~Bash's autoconversion syntax is described here. Delete this and all other italicisized instructions before distributing your readme.~~
28
29 === Bash Auto-Conversion
30 To trigger Wrye Bash's autoconversion...
31 * Choose the txt version of the file in Bash's Doc Browser.
32 * First line of txt file must look like <code>= Title ====#</code>. Note in particular, the <code>= </code> at the start and the single <code>#</code> character at the end!
33 * View the document in the Doc Browser. If Bash sees that the html is older than the text file, it will do the conversion. Note that this means that you can edit the text file in an external text editor and still get autoconversion.
34
35 == Custom Template
36 Copy this template to <code>Morrowind\Data Files\Docs\My Readme Template.txt</code> and modify as desired. That will become your default template.
37
38 === Css
39 {{CSS:wtxt_teal.css}}
40 The default styles can be replaced by specifying css file in a CSS tag. Note that:
41 * Css file must be on a line by itself.
42 * Css file is not linked to, but is instead included on compilation.
43 * Css must not contain any html markup tags (not even comments).
44 * Directory specification is not allowed.
45 * Css file must be present either in same directory as source document or in the <code>Morrowind\Data Files\Docs</code> directory. If it's present in both, then the version in the current directory will be used.
46 * If no css file is specified, then a default, sand colored style set will be used.
47 * You can supply your own css files or one of your own. If you use your own, please give a it unique name so that it won't overwrite css files by other modders. Included css files are:
48 * wtxt_teal.css
49 * A good place to put the CSS tag is at the end of the document.
50
51 === Heading 3
52 ==== Heading 4
53 Level of heading is determined by number of leading '='s. Trailing equal signs are ignored.
54
55 ===Bullets
56 * Bullets1
57 * Bullets 2
58 * Bullets 3
59 * Bullets 4
60 + Alternate bullet char
61 o Alternate bullet char
62 . Invisibile bullet char
63
64 === Styles
65 * ~~Italic~~
66 * __Bold__
67 * **BoldItalic**
68
69 ===Links
70 * External Link: [[http://www.wryemusings.com]] or [[http://www.wryemusings.com | Wrye Musings]]
71 * Internal Link: [[#ReuseandCredits| Reuse and Credits]] or [[#| Reuse and Credits]].
72 * {{A:Non-Header Anchor}} is linked to by [[#|Non-Header Anchor]]
73 * **Notes:**
74 * All section headers can be linked to by compressing the text of the header together (i.e., by stripping out all non alphabetical characters).
75 * If you use the second form the link is automatically generated from the text of the link.
76 * Note that all headers are autmatically anchored with with compressed text names. To create a link for non-header parts of the document, use the non-header anchor syntax.
77
78 === Html
79 * <i>Html tags work fine</i>
80 * <code>code tag has special formatting</code>
81 * **pre** tag is useful for code
82 <pre>
83 begin widgetScript
84 short counter
85 end
86 </pre>
87
88 === Continued Text
89 These will form one
90 line in the compiled
91 html.
92
93 + This will form one continuous
94 bullet item.
95
96 Blank lines can be used as spacers:
97
98
99 == Reuse and Credits ==========================================================
100 ~~Optional. Licenses are particularly useful for keeping mods alive after the original author(s) has left the scene and/or the original download server has gone down. The default license below is fairly generous. You can find other licenses at [[http://www.wryemusings.com/WML%201.0.html | Wrye Modding Licenses 1.0]] or you may wish to make your own. You can skip a license altogether, but this may result in your mod becoming unavailable eventually if you can't be contacted.~~
101
102 === License: WML 1.0 Modify and Redistribute, Share Alike
103 * You are free to redistribute this work in unmodified form.
104 * You are free to modify and re-distribute this work, so long as you: 1) give the author(s) credit proportional to their contribution to the final work, 2) distribute the final work under the same terms, and 3) make artistic resources included with the final work available under the same terms as below.
105 * Artistic resources (meshes, textures, sounds, etc.) included with this work may be included in unmodified form with modified versions of this work, so long as their authors are given credit proportional to their contribution to the final work. Note that artistic resources may not be modified, or extracted from this work, unless permission is given elsewhere.
106
107 === Courtesies
108 While the license above **allows** modification and redistribution, I'd **prefer** to keep it under my control for now. So, please try to contact me before modifying or redistributing it.
109
110 === License [Resources]
111 ~~Optional. If the mod has resources, and they are under a different license, note that here.~~
112
113 === Credits
114 ~~List who did what here. E.g... ~~
115 * **Bethesda**, for creating a great game!
116
117 === Contact
118 ~~Contact info. Email address, website, preferred forums, etc.~~
119

  ViewVC Help
Powered by ViewVC 1.1.22