Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
dboris committed May 26, 2024
1 parent 730a131 commit c4d3536
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ Camlkit provides OCaml bindings to the following Cocoa frameworks:
be developed entirely in OCaml.


## Getting started

The fastest way to get started developing an iOS app is to use the
[starter-template](https://github.com/dboris/camlkit-starter-nostoryboard).
Follow the instructions there to set up your environment. Build the
library with `make` and open the Xcode project with `make open`.


## Sample programs

A few sample programs are provided in the
Expand Down Expand Up @@ -93,11 +101,6 @@ let main () =
let () = main ()
```

The best way to get started is to peruse the sample programs and use them
as a starting template. Read the Apple documentation for the classes and methods
of interest. All books on iOS and macOS development in Objective-C are directly
applicable.


## Introduction

Expand Down Expand Up @@ -217,6 +220,8 @@ constructs by comparing the equivalent Objective-C and OCaml code.
At this time, the documentation of the project is lacking. The framework
bindings follow a regular naming pattern, so if you know the Objective-C method
you want to call, figuring the name of the OCaml function should be easy.
Read the Apple documentation for the classes and methods of interest.
All books on iOS and macOS development in Objective-C are directly applicable.

Some usefull sources you may wish to examine include:
* [Objective-C runtime bindings and basic functionality](https://github.com/dboris/camlkit/blob/main/runtime/runtime.ml)
Expand Down

0 comments on commit c4d3536

Please sign in to comment.