Skip to content

Commit 30401b3

Browse files
authored
Merge pull request #64 from divy9881/add-setup-doc
feat: add set-up guide.
2 parents 6812da5 + 3ff394b commit 30401b3

File tree

2 files changed

+23
-11
lines changed

2 files changed

+23
-11
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ Casbin-CPP
22
====
33

44
[![Build Status](https://dev.azure.com/Casbin/casbin/_apis/build/status/casbin.casbin-cpp?branchName=master)](https://dev.azure.com/Casbin/casbin/_build?definitionId=2&branchName=master)
5+
[![Build Status](https://travis-ci.org/casbin/casbin-cpp.svg?branch=master)](https://travis-ci.org/casbin/casbin-cpp)
56
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/casbin/casbin-cpp)](https://github.com/casbin/casbin-cpp/releases/latest)
67
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
78
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/casbin/lobby)
@@ -12,7 +13,7 @@ Casbin-CPP
1213
Operating Systems | Availability status
1314
----------------- | -------------------
1415
Windows (VS C++) | :heavy_check_mark: Available
15-
Linux and MacOS | :wrench: Under-Development
16+
Linux and MacOS | :heavy_check_mark: Available
1617

1718

1819
![casbin Logo](casbin-logo.png)
@@ -107,6 +108,27 @@ You can also use the online editor (https://casbin.org/editor/) to write your Ca
107108

108109
https://casbin.org/docs/en/tutorials
109110

111+
## Installation and Set-Up
112+
113+
#### Windows (Microsoft Visual Studio 2019)
114+
- `Clone` the repository in your target client project
115+
- Open the project solution and `build` the solution
116+
- To use the `casbin-cpp` project in your client project add the path to the static library `casbin.lib` file to your client project properties under `VC++ Directories` > `Library Directories` and also add the path of `casbin` directory to your client project properties under `VC++ Directories` > `Include Directories`
117+
- Add the static library file name `casbin.lib` to the properties under `Linker` > `Input` > `Additional Dependencies`
118+
119+
#### Unix
120+
- `Clone` the repository in your target client project
121+
- Change the current working directory to the `casbin-cpp` directory and build the library through following commands:
122+
```shell
123+
$ make
124+
$ make library
125+
```
126+
- To get rid of intermediate files generated during building of library:
127+
```shell
128+
$ make clean
129+
```
130+
- Now, you can use the file present in `lib` directory, created through `archiver`, as a static library
131+
110132
## Get started
111133

112134
1. New a Casbin enforcer with a model file and a policy file:

lgtm.yml

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)