Quantcast

Generate the project description from a README file.

Johnny C. Lam [09-24-12 - 18:13]
Generate the project description from a README file.

git-svn-id: svn://svn.curseforge.net/wow/ovale/mainline/trunk@553 d5049fe3-3747-40f7-a4b5-f36d6801af5f
Filename
.docmeta
README.md
diff --git a/.docmeta b/.docmeta
new file mode 100644
index 0000000..d0e0dd7
--- /dev/null
+++ b/.docmeta
@@ -0,0 +1,4 @@
+-
+    type: markdown
+    input-file: README.md
+    output-page: main
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8a07da0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,78 @@
+**It is still buggy at this time, depending on your spec.**  **None of the tank specs is available.**
+It takes a **lot** of work to update it to Mists of Pandaria and the process is not done.  Please be patient.  Thank you!
+
+[Ovale Spell Priority][ovale] shows you what spell or ability you should use in order to maximize your damage.
+
+  [ovale]: http://www.curse.com/addons/wow/ovale
+
+It displays one or more icons that show the cooldown of an action.  The action is conditionally defined through a user-defined script, e.g. you may display either [Corruption][] if the DoT is not on your target or [Shadow Bolt][] if the [Corruption][] DoT is already on your target.
+
+  [Corruption]: http://www.wowhead.com/spell=172
+  [Shadow Bolt]: http://www.wowhead.com/spell=686
+
+Default scripts are available for all dps and tank classes and specs, based on [SimulationCraft][].  There is an [online tool][wowdps] to import your [SimulationCraft][] profile (Mists of Pandaria only).  You may also customize the default script to suit your needs (see [Documentation][]) or use scripts made by other users.
+
+  [SimulationCraft]: http://code.google.com/p/simulationcraft/
+  [Documentation]: http://wow.curseforge.com/projects/ovale/pages/documentation/
+  [wowdps]: http://wowdps.com/
+
+See the [video of a survival hunter][ovale-video] using [Ovale][ovale] during Wrath of the Lich King.
+
+  [ovale-video]: http://www.youtube.com/watch?v=rNHvk9GpyiM	"Ovale WotLK video"
+
+**Please use the [forums][ovale-forums] to submit scripts or discuss them. If you want to report bugs, use the [ticket manager][ovale-tickets].**
+
+  [ovale-forums]: http://wow.curseforge.com/addons/ovale/forum/
+  [ovale-tickets]: http://wow.curseforge.com/addons/ovale/tickets/
+
+Features
+========
+
+- Default scripts for every class and talent specialization (except healers).
+- Tracks DoTs, buffs, debuffs, cooldowns, combo points, runes, mana, everything that a player would need to choose what to do.
+- Adapts to your talent points and glyphs.
+- Change quickly the configuration at any time with configurable checkboxes and drop-down lists that can be shown/hidden by clicking on the icons, e.g. switching between single and multi target damage, setting the curse or the judgment to cast.
+- Multi-target DoT tracking: remember which target had a DoT and when the DoT will expire, allowing the script author to support multi-target dotting.
+- Compatible with the action icon skinning library [Masque][].
+- 100% configurable: everything is in an easy to understand script that you can modify and test in real-time without reloading your UI.
+- Can be used to track crowd control spells on your focus.
+- Scoring system: evaluate how well you followed the script.  Add a new Ovale panel in Recount, with a score between 0 (very bad) and 1000 (perfect).
+- Up to two-spells-ahead accuracy with some classes.
+
+  [Masque]: http://www.curse.com/addons/wow/masque
+
+FAQ
+===
+
+##### Why does it not work for me?
+Try to reset your Profile in the [Ovale] settings, or press the `Restore default` button in the code window.  Most problems come from faulty scripts.
+
+##### Why is the key binding displayed for an action wrong?
+The action may be in several action bars, e.g., the bars that you can cycle through or the bars that appear in special cases like [Shadowform][] or [Cat Form][].
+
+  [Shadowform]: http://www.wowhead.com/spell=15473
+  [Cat Form]: http://www.wowhead.com/spell=768
+
+##### Why is the key binding not displayed at all?
+The action must be in your standard Blizzard action bar in order for [Ovale] to know which key binding is used.
+
+##### Why is the icon sometimes red?
+The cooldown that is displayed in an icon is not always the true action cooldown.  If this cooldown is longer than the action cooldown, then the icon is red.  In most cases, it means that if you use this action too soon, you will overwrite or clip a DoT, which may not be what you want.
+
+##### Why can't I click on the icon to cast the spell?
+Blizzard does not allow this.  Only a predefined sequence of spells can be bound to an action icon and this sequence can not change in combat.
+
+##### On my low-level character, there is nothing at all.
+You need to reach level 10 and choose a specialization
+
+##### There is no judgment or curse (or whatever) in the rotation.
+Click the icon and select the judgment or curse that you want to use from the dropdown menu list.
+
+Custom scripts
+==============
+- [SimulationCraft profile importer][wowdps]
+- [Ovale Spell Priority forums][ovale-forums]
+- [Nerien's Ovale Scripts][]
+- [The Fluid Druid kitty forums](http://fluiddruid.net/forum/viewforum.php?f=3)
+
+  [Nerien's Ovale Scripts]: http://www.curse.com/addons/wow/nerien-ovale-scripts