DOCSP-48728: CMake project instructions (#104)

* DOCSP-48728: CMake project instructions

* edits

* AS feedback

* edit

* edit

* tech review

Author: norareidy

source/get-started.txt

@@ -204,23 +204,7 @@ your operating system:
          vcpkg install mongo-c-driver
 
       After you install the driver, the standard CMake configuration file
-      is available, as well as the generated ``IMPORTED`` targets. You can
-      create a ``CMakeLists.txt`` file as shown in the following example:
-        
-      .. code-block:: cmake
-       
-         find_package(mongoc CONFIG REQUIRED)
-         target_link_libraries(my-application PRIVATE mongoc::mongoc)
-        
-      .. note::
-        
-         In the preceding example, the ``mongoc::mongoc`` target
-         points to either the static library or the shared library.
-         The library type depends on which one is available and
-         whichever type the user specifies in the ``MONGOC_DEFAULT_IMPORTED_LIBRARY_TYPE``
-         configuration setting. If you don't set this value and
-         both library types are available, ``mongoc::mongoc`` uses
-         the static library.
+      and the generated ``IMPORTED`` targets are available.
 
       To configure the CMake project with vcpkg integration, set the CMake
       toolchain file in the configuration command by running the following
@@ -257,13 +241,13 @@ your MongoDB database in the cloud.
 .. procedure::
    :style: connected
 
-   .. step:: Create a Free MongoDB deployment on Atlas
+   .. step:: Create a free MongoDB deployment on Atlas
 
       Complete the :atlas:`Get Started with Atlas </getting-started>`
       guide to set up a new Atlas account and load sample data into a new free
       tier MongoDB deployment.
 
-   .. step:: Save your Credentials
+   .. step:: Save your credentials
 
       After you create your database user, save that user's 
       username and password to a safe location for use in an upcoming step.
@@ -293,7 +277,7 @@ To connect to an instance or deployment not hosted on Atlas, see the
 .. procedure::
    :style: connected
 
-   .. step:: Find Your MongoDB Atlas Connection String
+   .. step:: Find your MongoDB Atlas connection string
 
       To retrieve your connection string for the deployment that
       you created in the :ref:`previous step <c-get-started-create-deployment>`,
@@ -314,15 +298,15 @@ To connect to an instance or deployment not hosted on Atlas, see the
       Deselect the :guilabel:`Include full driver code example` option to view
       only the connection string.
 
-   .. step:: Copy Your Connection String
+   .. step:: Copy your connection string
 
       Click the button on the right of the connection string to copy it
       to your clipboard, as shown in the following screenshot:
 
       .. figure:: /includes/figures/atlas_connection_copy_c.png
          :alt: The copy button next to the connection string in the Atlas UI
 
-   .. step:: Update the Placeholders
+   .. step:: Update the placeholders
 
       Paste this connection string into a file in your preferred text editor and
       replace the ``<db_username>`` and ``<db_password>`` placeholders with your
@@ -348,7 +332,7 @@ To learn more about the ``sample_mflix`` database, see :atlas:`Sample Mflix Data
 .. procedure::
    :style: connected
 
-   .. step:: Create a Project Directory
+   .. step:: Create a project directory
 
       In your shell, navigate to where you want to create your
       application, then run the following command to create a
@@ -380,28 +364,60 @@ To learn more about the ``sample_mflix`` database, see :atlas:`Sample Mflix Data
                   cd c-quickstart
                   type nul > quickstart.c
 
-   .. step:: Create Your C Driver Application
+   .. step:: Create your C Driver application
 
       Copy and paste the following code into the ``quickstart.c`` file, which queries
       the ``movies`` collection in the ``sample_mflix`` database:
 
       .. literalinclude:: /includes/get-started/quickstart.c
          :language: c
 
-   .. step:: Assign the Connection String
+   .. step:: Assign the connection string
 
       Replace the ``<connection string>`` placeholder with the
       connection string that you copied from the :ref:`c-get-started-connection-string`
       step of this guide.
 
+   .. step:: Set up a CMake application
+
+      To configure your application, create a ``CMakeLists.txt`` file in
+      your project directory. Then, add the following code to the file:
+
+      .. literalinclude:: /includes/get-started/CMakeLists.txt
+         :language: CMake
+         :dedent:
+
+      The preceding code performs the following actions:
+      
+      - Configures a C project.
+      - Creates a ``quickstart.out`` executable for your application.
+      - Finds and requires the {+driver-short+}. Replace the ``<version>``
+        placeholder with your {+driver-short+} version number, such as ``{+full-version+}``.
+      - Links the program to the ``libmongoc`` library.
+
+      .. note::
+
+         In the sample ``CMakeLists.txt`` file, the ``mongoc::mongoc`` target
+         points to either the static library or the shared library.
+         The library type depends on which one is available and
+         whichever type the user specifies in the ``MONGOC_DEFAULT_IMPORTED_LIBRARY_TYPE``
+         CMake configuration setting. If you don't set this value and
+         both library types are available, ``mongoc::mongoc`` uses
+         the static library.
+
+         You can use the ``mongoc::static`` target to explicitly use the 
+         static library or the ``mongoc::shared`` target to use the shared
+         library.
+
    .. step:: Run Your C Application
 
-      In your shell, run the following commands to compile and run this application:
+      In your shell, run the following commands to build and run this application:
 
       .. code-block:: none
 
-         gcc -o quickstartc quickstart.c $(pkg-config --libs --cflags libmongoc-1.0)
-         ./quickstartc   
+         cmake -S. -Bcmake-build
+         cmake --build cmake-build --target quickstart.out
+         ./cmake-build/quickstart.out
 
       The command line output contains details about the retrieved movie
       document:

source/includes/get-started/CMakeLists.txt

@@ -0,0 +1,5 @@
+cmake_minimum_required(VERSION 3.11)
+project(c-quickstart LANGUAGES C)
+add_executable (quickstart.out quickstart.c)
+find_package(mongoc <version> REQUIRED)
+target_link_libraries(quickstart.out mongoc::mongoc)