You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
_Couchbase Lite for C_ **beta** is available as a compressed binary download -- see: https://tbd
21
-
The unpacked released package contains these directories within the root directory ({rootdir}):
21
+
The unpacked download's root directory ({rootdir}) contains these directories:
22
22
23
23
* `lib` +
24
24
The `lib` folder contains binaries and other packaging components
@@ -27,15 +27,12 @@ The unpacked released package contains these directories within the root directo
27
27
* `bin` (*Windows-only*) +
28
28
Contains the Couchbase Lite for C `.dll` files.
29
29
30
-
Installation will vary by platform and compiler, but you can use these steps to install Couchbase Lite for C on any of the supported platforms:
30
+
Installation will vary by platform and compiler, but you can use these steps to install Couchbase Lite for C on any of the supported platforms -- see <<lbl-steps>>.
31
31
32
-
<<lbl-linux-steps, Linux>> |
33
-
<<lbl-windows-steps, Windows>> |
34
-
<<lbl-mac-steps, Mac OS>>
35
32
36
33
== Platforms
37
34
38
-
WARNING: For BETA releases, only the downloadable release package option is available
35
+
WARNING: For BETA releases, only the downloadable binary release option is available
The various Linux distributions contain the following packages within the root directory, {rootdir}:
70
69
71
70
[#tbl-linux-pkgs,cols="1,4", options="noheader"]
72
71
|===
73
72
74
-
|``**lcblite**``
73
+
|`lib`
75
74
| The core library package for running
76
75
77
-
|``**lcblite-dev**``
76
+
|`include`
78
77
|The headers and development files for _inclusion_
79
78
80
79
|===
81
80
82
-
=== Install from Download
83
81
84
82
[#lbl-linux-steps]
85
-
====
86
-
. *Download* and *Unpack* the release package
87
-
. From within the root directory, {rootdir},
88
-
.. Copy the following directories to a location already in the system path (for example, `/usr/include` or `/usr/local/lib`)
89
-
** lcblite
90
-
** lcblite-dev
83
+
. *Download* and *Unpack* the binary release
84
+
. From within the root directory, {rootdir}, copy the following directories to an appropriate location
85
+
*** lib
86
+
*** include
87
+
91
88
+
92
-
Your compiler will detect them automatically with no alterations needed
89
+
TIP: If you copy these to locations already in the system path (for example, `/usr/include` or `/usr/local/lib`), then your compiler will detect them automatically with no alterations needed
93
90
94
-
.. Alternatively:
95
-
... Add the `lcblite` location to your compiler's include path -- `<path-to>/lcblite`
96
-
... Add the `lcblite-dev` location to your compiler's linker search path -- `<path-to>/lcblite`
91
+
. Add the `lib` location to your compiler library search path (`-L`) -- `<path-to>/lib`
92
+
. Add the `include` location to your compiler's include path (`-I`) -- `<path-to>/include`
97
93
98
94
. Link with the binaries library using, for example, `gcc -lcblite`.
99
-
====
100
-
101
95
102
96
If you are familiar with _CMake_, then you can use this as a method of creating cross-platform projects; including Couchbase Lite itself.
103
97
As a convenience, the release package includes a _CMake_ file in `lib/cmake/CouchbaseLite`
98
+
--
104
99
105
-
106
-
[#install-windows]
107
-
== Windows
108
-
109
-
To install the Couchbase for C libraries on Windows from a downloaded release package:
100
+
Windows::
101
+
+
102
+
--
103
+
To install the Couchbase for C libraries on Windows from a downloaded release binary:
110
104
111
105
[#lbl-windows-steps]
112
106
. Download and extract the release package from http://tbd
@@ -119,35 +113,37 @@ Ensure you select the correct package for your application's compiler and archit
119
113
.. *Create* a new C++ project
120
114
+
121
115
Be sure to select x64 for 64-bit builds
122
-
.. Within *Project Properties* -> *C++ directories* -> *Include Directories*
. *Copy* `<path-to-deployed-directories>/bin/cblite.dll` to your build location
127
120
+
128
121
Couchbase Lite for C does not have any preferred installation path for the `.dll`.
129
122
It is up to you to determine where best to place it so it is available during execution, though copying to a location on the system path is not recommended on Windows
123
+
--
130
124
131
-
You will now be able to build and run your app .
132
-
133
-
134
-
== Mac OS
125
+
Mac OS::
126
+
+
127
+
--
135
128
136
129
To install the Couchbase for C libraries on Mac OS X from a downloaded release package:
137
130
138
131
[#lbl-mac-steps]
139
132
. Download and extract the release package from http://tbd
140
133
// codesign -sv <location>/lib/libcblite.3.dylib (note if you don't have an Apple developer account this won't work)
141
-
. From within the root directory, {rootdir}, *Copy* the `include` and `lib` folders to `/usr/local/`
134
+
. Ootionally ... From within the root directory, {rootdir}, *Copy* the `include` and `lib` folders to `/usr/local/`
142
135
. Within _Xcode_:
143
136
.. *Create* a new project
144
-
.. *Add* `/usr/local/include` to the project's _Header Search Path_
145
-
.. *Add* `/usr/local/lib` to the project's _Library Search Path_
137
+
.. *Add* `<path/to>/include` to the project's _Header Search Path_
138
+
.. *Add* `<path/to>/lib` to the project's _Library Search Path_
146
139
.. *Drag* `libcblite.3.dylib` into your Xcode project, then within the dialog:
147
140
... *Select* _Create Folder References If Needed_
148
141
... *Check* the correct target is selected
142
+
--
143
+
=====
149
144
150
-
You will now be able to build and run your app from Xcode.
145
+
On completion of the above steps you will be able to build and run your app.
0 commit comments