From d3b04f256323e1ea5c5c9736e4d9b51e6dd2bb5c Mon Sep 17 00:00:00 2001 From: Alex Rehnby-Martin Date: Wed, 3 May 2023 17:06:32 -0700 Subject: [PATCH] Minor Documentation changes --- docs/GettingStarted.md | 2 +- docs/building-the-aws-driver/BuildingTheAwsDriver.md | 1 + docs/testing-the-aws-driver/TestingTheAwsDriver.md | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md index 6f451c525..926697412 100644 --- a/docs/GettingStarted.md +++ b/docs/GettingStarted.md @@ -1,6 +1,6 @@ # Getting Started -## Obtaining the AWS Advanced JDBC Wrapper +## Obtaining the AWS ODBC Driver for MySQL You will find installers for Windows, MacOS and Linux that can be downloaded directly from [GitHub Releases](https://github.com/awslabs/aws-mysql-odbc/releases) to install the AWS ODBC Driver for MySQL. diff --git a/docs/building-the-aws-driver/BuildingTheAwsDriver.md b/docs/building-the-aws-driver/BuildingTheAwsDriver.md index f7c75d15a..fd785325d 100644 --- a/docs/building-the-aws-driver/BuildingTheAwsDriver.md +++ b/docs/building-the-aws-driver/BuildingTheAwsDriver.md @@ -19,6 +19,7 @@ - `cmake` - `mysql-client` - `mysql` + - `aws-sdk-cpp` 2. Set the environment variable MYSQL_DIR as the path to your `mysql-client` installation location: ``` export MYSQL_DIR=/usr/local/opt/mysql-client diff --git a/docs/testing-the-aws-driver/TestingTheAwsDriver.md b/docs/testing-the-aws-driver/TestingTheAwsDriver.md index 4bd19763f..18b16d9ec 100644 --- a/docs/testing-the-aws-driver/TestingTheAwsDriver.md +++ b/docs/testing-the-aws-driver/TestingTheAwsDriver.md @@ -17,7 +17,7 @@ cmake --build build --config Release ``` 2. There are two options to run the unit tests: - - Run `ctest` directly from the `unit_testing` directory. + - Run `ctest` directly from the `build/unit_testing` directory. - Navigate to `unit_testing/bin/Release` and run `unit_testing.exe`. To specify a particular test or test suite, include `--gtest_filter` in the command. The following example demonstrates running all the tests in the `TopologyServiceTest` suite with the `.\unit_testing.exe --gtest_filter=TopologyServiceTest.*` command: