Adjusted the README
This commit is contained in:
parent
8f2626ff08
commit
1b6ed9c970
41
README
41
README
|
@ -1,41 +0,0 @@
|
||||||
***********************************
|
|
||||||
THIS IS UNSTABLE AND ALPHA SOFTWARE
|
|
||||||
***********************************
|
|
||||||
|
|
||||||
-----------------------------------
|
|
||||||
Requirements:
|
|
||||||
You need the following software:
|
|
||||||
- Qt 5.3
|
|
||||||
- dmd 2.065
|
|
||||||
- gcc 4.8 or later with c++11 support
|
|
||||||
- nim 0.10.2
|
|
||||||
|
|
||||||
-----------------------------------
|
|
||||||
Build Instructions:
|
|
||||||
|
|
||||||
1) Open a shell terminal inside the cloned repo
|
|
||||||
2) mkdir build && cd build
|
|
||||||
3) cmake ..
|
|
||||||
4) make
|
|
||||||
|
|
||||||
-----------------------------------
|
|
||||||
Install Instructions:
|
|
||||||
|
|
||||||
For the C++ bridge:
|
|
||||||
1) Copy the libDOtherSide.so from the build dir
|
|
||||||
to your system lib i.e /usr/lib
|
|
||||||
|
|
||||||
For NimQml use the Nimble package manager:
|
|
||||||
1) Open a shell and navigate to the NimQml subdirectory
|
|
||||||
2) Type: nimble install
|
|
||||||
3) Now you can use it in your .nim files
|
|
||||||
|
|
||||||
-----------------------------------
|
|
||||||
Supported features:
|
|
||||||
- Creation of custom QObject and inject in a qml QtQuick view (both Nim and D)
|
|
||||||
- Slot and Signal creation for the following types int, bool, string (both Nim and D)
|
|
||||||
- Creation of properties for databinding (Nim only. D implementation is ongoing)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,38 @@
|
||||||
|
# DOtherSide
|
||||||
|
THIS IS UNSTABLE AND ALPHA SOFTWARE
|
||||||
|
|
||||||
|
## Description
|
||||||
|
Qml bindings for both D and Nim programming languages
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
You need the following software:
|
||||||
|
* Qt 5.3
|
||||||
|
* dmd 2.065
|
||||||
|
* gcc 4.8 or later with c++11 support
|
||||||
|
* nim 0.10.2
|
||||||
|
|
||||||
|
## Build Instructions
|
||||||
|
1. Open a shell terminal inside the cloned repo
|
||||||
|
2. mkdir build && cd build
|
||||||
|
3. cmake ..
|
||||||
|
4. make
|
||||||
|
|
||||||
|
## Install Instructions
|
||||||
|
For the C++ bridge:
|
||||||
|
|
||||||
|
1. Copy the libDOtherSide.so from the build dir to your system lib i.e /usr/lib
|
||||||
|
|
||||||
|
For NimQml use the Nimble package manager:
|
||||||
|
|
||||||
|
1. Open a shell and navigate to the NimQml subdirectory
|
||||||
|
2. Type: nimble install
|
||||||
|
3. Now you can use it in your .nim files
|
||||||
|
|
||||||
|
## Supported features:
|
||||||
|
* Creation of custom QObject and inject in a qml QtQuick view (both Nim and D)
|
||||||
|
* Slot and Signal creation for the following types int, bool, string (both Nim and D)
|
||||||
|
* Creation of properties for databinding (Nim only. D implementation is ongoing)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue