Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jacob-carlborg committed Jan 16, 2016
1 parent a5b23ea commit c5b6a60
Showing 1 changed file with 6 additions and 38 deletions.
44 changes: 6 additions & 38 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ DStep is a tool for translating C and Objective-C headers to D modules.

For the latest release see: [releases/latest](https://github.com/jacob-carlborg/dstep/releases/latest).

Pre-compiled binaries are available for Mac OS X, Linux and FreeBSD. As 32 and 64bit. See the
Pre-compiled binaries are available for OS X, Linux and FreeBSD, as 64bit. See the
[releases](https://github.com/jacob-carlborg/dstep/releases) section.

Arch packages are available in [community] repository (thanks to Михаил Страшун):
Expand All @@ -23,16 +23,16 @@ The source code is available under the [Boost Software License 1.0](http://www.b

### Requirements

* libclang - [http://clang.llvm.org](http://clang.llvm.org) - 3.1 or later
* DMD - [http://dlang.org/download.html](http://dlang.org/download.html) - 2.063.2 - 2.064.2
* Tango - [https://github.com/SiegeLord/Tango-D2](https://github.com/SiegeLord/Tango-D2)
* libclang - [http://clang.llvm.org](http://clang.llvm.org) - 3.1 or later that is binary compatible with 3.1
* DMD - [http://dlang.org/download.html](http://dlang.org/download.html) - 2.069.2
* Dub [http://code.dlang.org/download](http://code.dlang.org/download)

### Building

1. Install all requirements, see [below](#requirements-1)
1. Install all requirements, see [above](#requirements)
2. Clone the repository by running:

$ git clone --recursive git://github.com/jacob-carlborg/dstep.git
$ git clone git://github.com/jacob-carlborg/dstep.git

3. run `dub build`

Expand All @@ -46,38 +46,6 @@ For translating Objective-C headers add the `-ObjC` flag.

Use `-h` for usage information. Any flags recognized by Clang can be used.

## Requirements

### libclang

This tool requires libclang. Any version that is 3.1 or later and binary compatible with 3.1
should work. Either download the pre-compatible libraries from the LLVM site or use libclang
shipping with your system or available from the system package manager.

Some header files will require "stdarg.h" and/or "stddef.h". These are so called builtin
includes and are shipped with Clang. They need to be placed in the standard header locations
or explicitly referenced with the `-I` flag. For more information see the
[Clang FAQ](http://clang.llvm.org/docs/FAQ.html#i-get-errors-about-some-headers-being-missing-stddef-h-stdarg-h).

Download the pre-compiled libraries here:

[http://llvm.org/releases/download.html#3.1](http://llvm.org/releases/download.html#3.1)

Alternatively compile libclang yourself:

$ git clone http://llvm.org/git/llvm.git
$ cd llvm
$ git checkout release_31
$ cd tools
$ git clone http://llvm.org/git/clang.git
$ cd clang
$ git checkout release_31
$ cd ../..
$ ./configure --enable-optimized
$ cp Release+Asserts/lib/libclang.<dylib|so> <path/to/dstep>

### [Dub](http://code.dlang.org/download)

## Limitations/Known issues

* Doesn't translate preprocessor macros of any kind
Expand Down

0 comments on commit c5b6a60

Please sign in to comment.