diff --git a/README.md b/README.md index c548289..a867397 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,51 @@ -openkeyboard -============ +![screenshot](/images/layout_keyboard.png?raw=true) +![screenshot](/images/layout_media.png?raw=true) +![screenshot](/images/layout_blender.png?raw=true) + +# OpenKeyboard + +**Purpose**: +This keyboard app is meant for Windows tablet users. The default keyboard starting with windows 8 is pretty big which takes up quite a bit of screen space. So originally this was to create a small and useful keyboard that expanded into being able to create any sort of keyboard that can run short cuts. For example, there is a Blender3D layout that has many useful quick keys setup to perform many functions within the application. This is great if you are modeling using a Surface Pro and want to be able to quickly use the touch screen instead of the keyboard to activiate a few functions. + + +**Feature list**: + + * Custom Keyboard Layouts by add/editing XML files + * Resizable, keys will resize along with the window. + * Opacity can be set so its out of the way + * Custom popup menus on any button to save space on less used items. + * Uses Font-Awsome to create icons for buttons. + * Portable, so just unzip and run. + +___ + +### Create New Layout +The easiest way is to probably take an existing layout and start tweaking it. The way the layout works is by Rows, then you add all the keys you want for each row. You are able to give weight to keys so some will appear longer then others. You can also assign a custom menu on a button if you want to avoid making your layout to big. + +Another great feature is to set the border around the application. This allows you to set where its easier to touch drag the keyboard around. Depending on the layout you might want the border to be thicker on the side instead of at the top. + +Here a simple example of a layout xml file. + +```xml + + + + + + + + + + + + + + + + + +``` + +**Things that may be of help:** +* [FontAwesome CheetSheet](http://fortawesome.github.io/Font-Awesome/cheatsheet/) + diff --git a/images/layout_blender.png b/images/layout_blender.png new file mode 100644 index 0000000..2466130 Binary files /dev/null and b/images/layout_blender.png differ diff --git a/images/layout_keyboard.png b/images/layout_keyboard.png new file mode 100644 index 0000000..32d6f96 Binary files /dev/null and b/images/layout_keyboard.png differ diff --git a/images/layout_media.png b/images/layout_media.png new file mode 100644 index 0000000..eaf66af Binary files /dev/null and b/images/layout_media.png differ