From c768a8378cabc0786349ad0476ad8a2a0ebd6a36 Mon Sep 17 00:00:00 2001 From: AlecGrover <39810460+AlecGrover@users.noreply.github.com> Date: Tue, 19 Mar 2019 20:00:24 -0700 Subject: [PATCH 1/2] Update to README.md readability - Changed some wording in the Synopsis and C sections to improve concision - Removed an errant comma in the section on C --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 56a3015..d6ac0d6 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ ## Synopsis -This is an implementation of the Ayxia Trace Client C/C++ API that provides encapsulation of the protocol used to send trace messages to the Ayxia Trace GUI. +This implementation of the Ayxia Trace Client C/C++ API provides encapsulation of the protocol used to send trace messages to the Ayxia Trace GUI. -The C++ API provides the best performance since it can take advantage of variadic templates to gather type information which can be used to perform text formatting in the viewer application instead of in the code being traced. This can result in significant speedups. +The C++ API provides the best performance by taking advantage of variadic templates to gather type information which can be used to to format text in the viewer application instead of in the code being traced. This can result in significant speedups. ## Log Viewer @@ -31,7 +31,7 @@ int main() ### C -Using C isn't quite as easy because it uses printf format to format the string, so all of the caveats that come with printf also apply, for example using %s with an integer value will likely cause a fault, or trying to format a floating point value with %d will give you incorrect results. +Using C isn't as easy. C uses printf to format the string, so all of the caveats that come with printf also apply, for example, using %s with an integer value will likely cause a fault or trying to format a floating point value with %d will give you incorrect results. ```C TRACE_INFO("some.channel", "this is a test %d", i); From fbe099546521e105aed59f4ecbb55c47d2336c2f Mon Sep 17 00:00:00 2001 From: AlecGrover <39810460+AlecGrover@users.noreply.github.com> Date: Tue, 19 Mar 2019 20:40:04 -0700 Subject: [PATCH 2/2] removed double "to" --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d6ac0d6..e477725 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This implementation of the Ayxia Trace Client C/C++ API provides encapsulation of the protocol used to send trace messages to the Ayxia Trace GUI. -The C++ API provides the best performance by taking advantage of variadic templates to gather type information which can be used to to format text in the viewer application instead of in the code being traced. This can result in significant speedups. +The C++ API provides the best performance by taking advantage of variadic templates to gather type information which can be used to format text in the viewer application instead of in the code being traced. This can result in significant speedups. ## Log Viewer