summaryrefslogtreecommitdiffstats
path: root/src/main/javadoc/overview.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/javadoc/overview.html')
-rw-r--r--src/main/javadoc/overview.html17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html
new file mode 100644
index 00000000..e96bf35e
--- /dev/null
+++ b/src/main/javadoc/overview.html
@@ -0,0 +1,17 @@
+<body>
+ <p>Bukkit, the plugin development framework.</p>
+
+ <p>
+ The documentation is for developing plugins and is split into the
+ respective packages for each subject matter. This documentation does not
+ cover running a server, contributing code back to the project, or setting
+ up a workspace. Working knowledge of the Java language is a prerequisite
+ for developing plugins.
+ </p><p>
+ For basic plugin development, see the {@link org.bukkit.plugin plugin
+ package}. It covers the basic requirements of a plugin jar.
+ </p><p>
+ For handling events and triggered code, see the {@link org.bukkit.event
+ event package}.
+ </p>
+</body>