aboutsummaryrefslogtreecommitdiff
path: root/Readme.md
diff options
context:
space:
mode:
authorCamil Staps2015-08-07 12:06:59 +0200
committerCamil Staps2015-08-07 12:06:59 +0200
commit1cb84f1dd14c2bc13bb17b2a4095e4432498399c (patch)
tree22fab5c332dc6f91d345e9b64006867c241b04e7 /Readme.md
parentFixed some issues with strings (diff)
Readme, LICENSE
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..4bc7605
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,34 @@
+# ObjectIO
+
+[ObjectIO][objectio] is a [Clean][clean] library "to create Clean programs that have a Graphical User Interface (GUI)". There is [a tutorial][objectio_tut] available. Unfortunately, support is limited to Windows and Mac for the moment. In the [complete sources of Clean 2.4][clean_download], however, a start has been made to support Linux as well using [GTK+ 2][gtk2]. The code in that download is buggy and unusable, especially on 64 bit systems.
+
+This project is an attempt to fix the Linux variant of Clean's ObjectIO library. In the initial commit the source code from the [Clean 2.4 sources][clean_download] has been copied. All other commits were authored by [Camil Staps][camilstaps].
+
+## Legal
+
+The ObjectIO library is subject to the [Clean License Conditions][clean_license], which means it is available under the LGPL and a commercial license.
+
+This project however is licensed under the GPL 3.0 license. For more information, see the LICENSE file.
+
+## To do
+
+* This project is still in early development. Some simple programs (like "Hello World") are already working. However, many things are not working yet and many things still remain untested.
+* In a future version, it would be preferable to switch to GTK+ 3.
+
+## Invitation
+
+You are invited to help fixing this library by forking this repository. If you make significant progress, please create a pull request.
+
+If you would like some help to get started with this library's development, please drop me an email at [info@camilstaps.nl][camilstaps_mail] and we can have a look together.
+
+[objectio]: http://clean.cs.ru.nl/Object_I/O
+[objectio_tut]: http://clean.cs.ru.nl/download/supported/ObjectIO.1.2/doc/tutorial.pdf
+[clean]: http://clean.cs.ru.nl/Clean
+[clean_download]: http://clean.cs.ru.nl/Download_Clean
+[clean_license]: http://clean.cs.ru.nl/Clean_license_conditions
+
+[gtk2]: https://developer.gnome.org/gtk2
+
+[camilstaps]: http://www.camilstaps.nl
+[camilstaps_email]: mailto:info@camilstaps.nl
+