Skip to content

Update to README.md readability #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AlecGrover wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update to README.md readability #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c768a83
Update to README.md readability
AlecGrover Mar 20, 2019
fbe0995
removed double "to"
AlecGrover Mar 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 format text in the viewer application instead of in the code being traced. This can result in significant speedups.

## Log Viewer

Expand All @@ -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);
Expand Down