Permalink
Browse files

READMEs fixed

  • Loading branch information...
1 parent 53f92c1 commit 9d4b15584fb64df5e10dbe37453160867cabd93d @Kakadu committed Apr 11, 2013
Showing with 39 additions and 30 deletions.
  1. +11 −0 README.md
  2. +0 −26 README_QML.md
  3. +20 −0 qml/README_QML.md
  4. +1 −4 { → qtgui}/README
  5. +7 −0 src/README.md
View
@@ -0,0 +1,11 @@
+There you can find my experienca about interfacing OCaml and Qt.
+
+* QtQuick + OCaml stuff is in `qml/`.
+* QtGui + OCaml is probably outdated and not compiled. I have paused my work with it. See build environment in `qtgui/`
+* Both project share same codegenerator which is located in `src/`
+
+See corresponding READMEs for more details
+
+Happy hacking,
+Kakadu
+
View
@@ -1,26 +0,0 @@
-This repo contins my thoughts about interfacing Qt and OCaml.
-
-I have started developing from QtGui but last time I deal with QtQuick because it is more perspective technology.
-
-In this repo you can find generator for interfacing OCaml and QML. Its sources are located in src/. Generator does not depend on any C++ libraries, only OCaml ones: core, ocamlgraph, tarjangraph.
- * core ia available in opam
- * ocaml-syck library to deal with YAML files. Use `bzr branch lp:ubuntu/ocaml-syck` to get it.
- N.B. just `make && make install DEST=....`, no any `./configure`.
- TODO: finish my opam patches about bazaar support.
-
-To build generator it will be enough to execute
-`cd src && ./configure && ocamlbuild mocml/mocml.native`
-
-
-Test example uses library which can be found at `qml/lib`. Do not forget to configure your pkg-config for Qt5.
-
-Test example can be found in `qml/lib/test`. There is Makefile there to build it. This example uses custom component Qt.labs.FolderListModel which can be built using `build_forlderlistmodel` script. You can built example itself using Makefile. Script `./configure` generates some files using `mocml` generator mentioned before. Dont forget to add symlink to it: `ln -s ../../../src/mocml.native mocml`.
-
-N.B. This example is OCamlBrowser clone and it depends on `compiler-libs` ocamlfind package. Thats why you need ocaml(>=4.00.1).
-
-
-After that you can run `make` and get `./main` executable. I usually test it by running
-
- ./main -I `ocamlc -where` -I `ocamlfind query core`
-
-
View
@@ -0,0 +1,20 @@
+I have started developing from QtGui but last time I deal with QtQuick because it is more perspective technology.
+
+In this repo you can find generator for interfacing OCaml and QML. Its sources are located in `../src`. Generator does not depend on any C++ libraries, only OCaml ones: core, ocamlgraph, yojson.
+
+To build generator it will be enough to execute
+`cd ../src && ./configure && ocamlbuild mocml/mocml.native`
+
+
+Test example uses library which can be found at `lib`. Do not forget to configure your pkg-config for Qt5.
+
+Test example can be found in `lib/test`. There is Makefile there to build it. This example uses custom component Qt.labs.FolderListModel which can be built using `build_forlderlistmodel` script. You can built example itself using Makefile. Script `./configure` generates some files using `mocml` generator mentioned before. Dont forget to add symlink to it: `ln -s ../../../src/mocml.native mocml`.
+
+N.B. This example is OCamlBrowser clone and it depends on `compiler-libs` ocamlfind package. Thats why you need ocaml(>=4.00.1).
+
+
+After that you can run `make` and get `./main` executable. I usually test it by running
+
+ ./main -I `ocamlc -where` -I `ocamlfind query core`
+
+
View
@@ -1,8 +1,5 @@
-Qml test application is in qml/lib/test
-It depends on code in src, qml/lib and Qt5 stuff. I recently removed hardcoded paths to Qt5, so I leave configuring environment to you.
-
====================================================
-My thoughts about which bindings for Qt should be
+My thoughts about which bindings for QtGui should be. I paused developing of this project and I'm focused now on QtQuick. See `../qml/` for details.
File `build.ml` is a script for pseudo-autobuild.
You can download and compile lablqt automatically (if all depends are installed) using these commands.
View
@@ -0,0 +1,7 @@
+In this folder you can find code which performs code generation for Qt?+OCaml projects. It contains 1 library and 3 executables.
+ * Library `lablqt` declares basic API and types for representing inforamtion about C++ classes. All executables depend on it.
+ * Executable `generator` is used to generate binding code for QtGui+OCaml. Its implementation sucks but works somehow.
+ * Executable `xmltool` is used to filter input XML files for `generator`.
+ * Executable `mocml` is a generator for OCaml+QML project. You don't need to other executables for hacking QML-related ocaml code. `mocml` reads input file in JSON format, and using this information about C++ API generates wrappers to call OCaml from C++/ECMAscript. For some examples see `../qml` directory
+
+

0 comments on commit 9d4b155

Please sign in to comment.