From 7c1e176320e709c5b0852e7dd73fb35681c0cd32 Mon Sep 17 00:00:00 2001 From: Olof Larsson Date: Sun, 6 Feb 2011 15:09:13 +0100 Subject: [PATCH] Improved reamefile again --- README.md | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index c172f1dc..7a6faf18 100644 --- a/README.md +++ b/README.md @@ -11,41 +11,43 @@ With this plugin... Usage --------- The chat console command is: -`/f` + + * `/f` This command has subcommands like: -`/f create My faction name` -`/f invite my friends name` -`/f claim` -`/f map` -... etc -Read the full guide here: +* `/f create My faction name` +* `/f invite my friends name` +* `/f claim` +* `/f map` +* ... etc -http://mcteam.org/factions +Read the full userguide here: [http://mcteam.org/factions](http://mcteam.org/factions) You may also read the documentation ingame as the plugin ships with an ingame help manual. Read the help pages like this: -`/f help 1` -`/f help 2` -`/f help 1` + +* `/f help 1` +* `/f help 2` +* `/f help 1` Note that you may optionally skip the slash and just write -`f` + +* `f` Installing --------- -1. Download the latest release: https://github.com/oloflarsson/Factions/raw/master/releases/latest.zip +1. Download the latest release: [latest.zip](https://github.com/oloflarsson/Factions/raw/master/releases/latest.zip) 1. Put the included gson.jar here `/your_server_folder/gson.jar` 1. Put the included Factions.jar here `/your_server_folder/plugins/Factions.jar` Compiling --------- -You will need the Bukkit library to compile (Bukkit.jar) -You can download it here: http://bamboo.lukegb.com/browse/BUKKIT-BUKKITMAIN/ +You will need the Bukkit library to compile (Bukkit.jar)
+You can download it here: [http://bamboo.lukegb.com/browse/BUKKIT-BUKKITMAIN/](http://bamboo.lukegb.com/browse/BUKKIT-BUKKITMAIN/) -You will also need Google GSON in your build path. -You can download it here: http://code.google.com/p/google-gson/ -OR you can use the gson.jar in the folder `/packaging` +You will also need Google GSON in your build path.
+You can download it here: [http://code.google.com/p/google-gson/](http://code.google.com/p/google-gson/)
+OR you can use the file in this repo `/packaging/gson.jar`
However you won't get javadocs and source that way. You will need to include the MANIFEST.MF and plugin.yml in your jar. All bukkit plugins need a plugin.yml and the MANIFEST.MF is needed for the plugin to find the gson.jar (wich should be in the same folder as the main server jar when running the server). \ No newline at end of file