Skip to content

Commit 515c523

Browse files
authored
DOC-8132-C3 -- C Lang Get started tweak (#494)
https://issues.couchbase.com/browse/DOC-8132
1 parent 179d76f commit 515c523

File tree

3 files changed

+30
-34
lines changed

3 files changed

+30
-34
lines changed

modules/ROOT/pages/_partials/nav-skeleton-start-clang.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
.xref:couchbase-lite:clang:quickstart.adoc[{param-title}]
22
// tag::get-started[]
3-
* xref:{cbl-pg-prereqs}[Start Here!]
4-
.Start Here!
3+
4+
* Start Here!
55
// tag::start[]
6+
// ** {gs-prereqs--xref}
67
** {gs-install--xref}
78
// end::start[]
89
** {gs-build--xref}

modules/clang/pages/gs-build.adoc

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,29 @@
55
:keywords: mobile edge nosql api iOS C web-app device-app
66

77
include::partial$_std-cbl-hdr-clang.adoc[]
8-
98
include::{root-partials}block-abstract.adoc[]
109

11-
== Verify Install
12-
1310
:param-page: {page-relative-src-path}
1411
include::{root-partials}_get-started-topic-group.adoc[]
1512

1613

17-
Now you have the Couchbase Lite for C installed, you can verify it builds correctly.
14+
== Verify Install
15+
16+
Now you have _Couchbase Lite for C_ installed, you can verify that your apps build correctly.
1817

19-
Enter the sample C app below into your editor of choice and build it.
18+
Enter the C code in <<ex-clang-starter>> into your editor of choice and build it.
2019

2120
Running it will create a database, add a document, retrieve the document, update the document and then delete the document.
2221

22+
.Sample code
2323
[#ex-clang-starter]
24+
====
2425
[source, c]
2526
----
2627
//
2728
// main.c
2829
// clang300testProd
29-
//
30-
// Created by Ian Bridge on 06/08/2021.
31-
//
30+
3231
3332
// STILL A WORK IN PROGRESS
3433
@@ -61,11 +60,9 @@ int main(int argc, const char * argv[]) {
6160
6261
return 0;
6362
}
64-
///Users/ianbridge/CouchbaseDev/test-clang/test-clang-proj/clang-test-prod/clang-test-prod
65-
///test-clang-proj/clang-test-prod/clang-test-prod
6663
6764
----
68-
65+
====
6966

7067

7168
include::{root-partials}block-related-content-start.adoc[]

modules/clang/pages/gs-install.adoc

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,25 @@ include::{root-partials}block-abstract.adoc[]
1313
:param-page: {page-relative-src-path}
1414
include::{root-partials}_get-started-topic-group.adoc[]
1515

16+
17+
== Package
18+
19+
Couchbase Lite for C **beta** is available as a compressed binary download -- see: https://tbd
20+
The unpacked released package contains these top-level folders:
21+
22+
* `lib` +
23+
The `lib` folder contains binaries and other packaging components
24+
* `include` +
25+
The `include` directory contains all the headers that the library offers
26+
* `bin` (*Windows-only*) +
27+
Contains the Couchbase Lite for C `.dll` files.
28+
29+
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+
31+
<<lbl-linux-steps, Linux>> |
32+
<<lbl-windows-steps, Windows>> |
33+
<<lbl-mac-steps, Mac OS>>
34+
1635
== Platforms
1736

1837
WARNING: For BETA releases, only the downloadable release package option is available
@@ -39,24 +58,6 @@ a|* <<lbl-linux-repos,apt>>
3958
|===
4059

4160

42-
== Package
43-
44-
Couchbase Lite for C **beta** is available as a compressed binary download -- see: https://tbd
45-
The unpacked released package contains these top-level folders:
46-
47-
* `lib` +
48-
The `lib` folder contains binaries and other packaging components
49-
* `include` +
50-
The `include` directory contains all the headers that the library offers
51-
* `bin` (*Windows-only*) +
52-
Contains the Couchbase Lite for C `.dll` files.
53-
54-
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:
55-
56-
<<lbl-linux-steps, Linux>> |
57-
<<lbl-windows-steps, Windows>> |
58-
<<lbl-mac-steps, Mac OS>>
59-
6061

6162
== Linux
6263

@@ -379,7 +380,4 @@ You will now be able to build and run your app from Xcode.
379380
// ----
380381
// ====
381382

382-
383-
384-
385383
include::{root-partials}block-related-content-start.adoc[]

0 commit comments

Comments
 (0)