From 2322c010586597ffbec797d88f078dd96fccaef4 Mon Sep 17 00:00:00 2001
From: Samuel Mehrbrodt <Samuel.Mehrbrodt@cib.de>
Date: Thu, 7 Apr 2016 12:32:05 +0200
Subject: [PATCH] Add Getting started guide to README

---
 README.md | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 9eb8a56..9f84c48 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
-# libreoffice-starter-plugin
-LibreOffice Extension boilerplate
+# LibreOffice Starter Plugin
+
+This repository contains some boilerplate code and config you need to get started to build your own LibreOffice Extension.
+
+You can use this project as a starting point to write your own extension for LibreOffice.
+
+## Get started
+
+# Install [LibreOffice](http://www.libreoffice.org/download) & [LibreOffice SDK](http://www.libreoffice.org/download) (5.0 or greater)
+# Install [Eclipse](http://www.eclipse.org/) & the [LOEclipse plugin](https://github.com/LibreOffice/loeclipse/#installation)
+# [Download](https://github.com/smehrbrodt/libreoffice-starter-plugin/archive/master.zip) this starter project & unzip it
+# Import the project in Eclipse (File->Import->Existing Projects into Workspace)
+# Let Eclipse know the paths to LibreOffice & the SDK (Project->Properties->UNO Properties)
+# Setup Run Configuration
+## Go to Run->Run Configurations
+## Create a new run configuration of the type "LibreOffice Application"
+## Select the project
+## Run!
+## *Hint: Show the error log to view the output of the run configuration (Window->Show View->Error Log)*
+# The extension will be installed in LibreOffice and you will see a toolbar and a menu entry have been added to Writer.
+
+## Development Hints
+* The entry point is in [source/org/libreoffice/example/comp/StarterProjectImpl](https://github.com/smehrbrodt/libreoffice-starter-plugin/blob/master/source/org/libreoffice/example/comp/StarterProjectImpl.java).
+* Toolbar items and menu entries are defined in [registry/org/openoffice/Office/Addons.xcu](https://github.com/smehrbrodt/libreoffice-starter-plugin/blob/master/registry/org/openoffice/Office/Addons.xcu).
+* Shortcuts are defined in [registry/org/openoffice/Office/Accelerators.xcu](https://github.com/smehrbrodt/libreoffice-starter-plugin/blob/master/registry/org/openoffice/Office/Accelerators.xcu).
+* The position of the toolbar is defined in [registry/org/openoffice/Office/UI/WriterWindowState.xcu](https://github.com/smehrbrodt/libreoffice-starter-plugin/blob/master/registry/org/openoffice/Office/UI/WriterWindowState.xcu).
+* The dialog shown when clicking "Action One" is in [dialog/ActionOneDialog.xdl]. The dialog itself contains information how to edit it.
+* The [DialogHelper](https://github.com/smehrbrodt/libreoffice-starter-plugin/blob/master/source/org/libreoffice/example/helper/DialogHelper.java) contains lots of helper methods to work with the dialog.
+* Now go on customizing the extension to your needs. You'll find lots of information in the [OpenOffice Wiki](https://wiki.openoffice.org/wiki/Extensions_development).