Skip to content

Commit 557b0a6

Browse files
authored
Update README.md
1 parent c4ff0cf commit 557b0a6

File tree

1 file changed

+3
-33
lines changed

1 file changed

+3
-33
lines changed

README.md

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,5 @@
1-
# OptiKey
1+
# OptiKey Coder
22

3-
OptiKey is an on-screen keyboard that is designed to help Motor Neuron Disease (MND) patients interact with Windows computers. When used with an eye-tracking device, OptiKey's on-screen keyboard allows MND patients to complete tasks, such as email composition, using only their eyes. OptiKey can also be used with a mouse or webcam. Unlike expensive and unreliable Alternative and Augmentative Communication (AAC) products that are difficult to use, Optikey is free, reliable, and easy to use.
3+
This is an experimental fork of [OptiKey](https://github.com/OptiKey/OptiKey) with some features and ideas specific to users who want to write code.
44

5-
# Getting Started
6-
7-
[**The OptiKey Wiki**](https://github.com/OptiKey/OptiKey/wiki) contains OptiKey's user guides, installation and system requirements, and additional support information. OptiKey's Windows installer can be downloaded from the [latest release](https://github.com/JuliusSweetland/OptiKey/releases/latest). To get an understanding of OptiKey's use, users should watch [Optikey's introduction video](https://www.youtube.com/watch?v=HLkyORh7vKk).
8-
9-
# Supported Platforms
10-
11-
OptiKey uses the .Net 4.6 Framework and is designed to run on Windows 8 / 8.1 / 10.
12-
13-
# Problems?
14-
15-
If users encounter an issue with OptiKey, such as a software crash or an unexpected behaviour, users should add an issue ticket to [OptiKey's issue tracker](https://github.com/OptiKey/OptiKey/issues). Users are encouraged to check if their issue is already being tracked by OptiKey before creating a new issue ticket.
16-
17-
The following information should be specified in an issue ticket:
18-
19-
* How OptiKey was being used
20-
* What the user expected to happen
21-
* What the user actually experienced
22-
* Steps to reproduce the issue
23-
* Any other information that helps to describe and/or reproduce the problem (ex. screenshots)
24-
25-
# License
26-
27-
Licensed under the GNU GENERAL PUBLIC LICENSE (Version 3, 29th June 2007)
28-
29-
# Contributing
30-
31-
Contributions to this project are always welcome. If you'd like to help translate Optikey to another language, fix bugs or add new features, check out our [Contributing page](https://github.com/OptiKey/OptiKey/wiki/Contribute).
32-
33-
# Contact
34-
35-
To ask a question, or to discuss information that is not on the [**OptiKey Wiki**](https://github.com/JuliusSweetland/OptiKey/wiki/), please use <julius@optikey.org> or <optikeyfeedback@gmail.com> to contact Julius.
5+
There is a low bar to adding features/hacks in the interest of trialling different workflows and seeing what is most helpful. However, the stability this fork is not guaranteed - if you like a feature, open an issue to discuss whether it's appropriate for going back into the core Optikey app.

0 commit comments

Comments
 (0)