dotherside/README.md

56 lines
2.2 KiB
Markdown
Raw Normal View History

2014-12-29 15:12:37 +00:00
# DOtherSide
2015-09-15 20:08:29 +00:00
[![License](https://img.shields.io/badge/license-LGPL-green.svg)](https://github.com/filcuc/DOtherSide/blob/master/LICENSE)
2015-09-11 22:48:35 +00:00
[![Build Status](https://travis-ci.org/filcuc/DOtherSide.svg?branch=master)](https://travis-ci.org/filcuc/DOtherSide)
2016-01-29 21:50:43 +00:00
[![Build status](https://ci.appveyor.com/api/projects/status/ufufhtv2h507sd96/branch/master?svg=true)](https://ci.appveyor.com/project/filcuc/dotherside/branch/master)
2015-09-11 22:48:35 +00:00
2015-09-15 19:52:52 +00:00
C language library for creating bindings for the Qt QML language.
2015-09-15 19:52:52 +00:00
Currently the DOtherSide library is used by the following bindings:
* [nimqml](https://github.com/filcuc/nimqml), QML bindings for the Nim programming language
* [dqml](https://github.com/filcuc/dqml), QML bindings for the D programming language
## Supported features
The following features are implementable from a binding language
* Creating custom QObject
* Creating custom QAbstractListModels
* Creating custom properties, signals and slots
* Creating from QML QObject defined in the binded language
## Prebuilt binaries
Currently we provide the prebuilt binaries for the following
Linux distributions through the [OpenSUSE OBS service](https://build.opensuse.org/package/show/home:filcuc/DOtherSide)
* ```Archlinux``` : [here](http://software.opensuse.org/download.html?project=home%3Afilcuc&package=DOtherSide)
## Change log
The project change log can be read [here](./CHANGELOG.md).
2015-09-15 19:52:52 +00:00
## Supported platforms
2015-03-11 21:00:09 +00:00
Currently we support the following platforms/compilers:
- Linux both 32/64bit with gcc
2015-09-05 12:19:47 +00:00
- Windows 32/64bit with Visual Studio 2013 Community Edition
2015-09-15 19:52:52 +00:00
## Build requirements
2014-12-29 15:12:37 +00:00
You need the following software:
2015-05-02 12:03:32 +00:00
* Qt 5.3 or higher
2015-07-12 11:05:37 +00:00
* Linux: gcc 4.8 or later with c++11 support or higher
* Windows: Visual Studio 2013 Community Edition (Windows) or higher
* Windows: MingGW 4.9.2 or higher
2014-12-29 15:12:37 +00:00
2015-09-15 19:52:52 +00:00
## Build instructions:
2014-12-29 15:12:37 +00:00
1. Open a shell terminal inside the cloned repo
2. mkdir build && cd build
3. cmake ..
4. make
## Install Instructions
Once you built the package just type
```
make install
```
by default cmake will install to the default CMAKE prefix.
If you want to customize this location type the following command
during the build steps when invoking cmake
```
cmake -DCMAKE_INSTALL_PREFIX:PATH=/path/to/install/prefix path/to/CMakeLists.txt
```