Skip to content

Commit

Permalink
Fix some typos and wording. (#14)
Browse files Browse the repository at this point in the history
* Fix some typos and wording.

* Update README.md
  • Loading branch information
musm authored Oct 1, 2020
1 parent feb5003 commit 09d57f8
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,12 @@ pkg> add WinTypes

## Motivation & Examples

This makes it easier/quicker/more convenient to translate Windows API function from Julia
and also improves readability with respect to the original function definitions in the
Windows API.
The point of this package is to make it easier and more convenient to wrap Windows API function calls in Julia.
As a consequence, this package also improves readability with respect to the original Windows API function definitions.

Here's an example comparing calling Windows API functions with and without `WinTypes`:
Here's an example comparing wraping Windows API functions with and without `WinTypes`:

With `WinTypes` a Windows API call would look something like:
**Using `WinTypes` a Windows API call would look something like:**
```julia
using WinTypes: HANDLE, DWORD, BOOL

Expand All @@ -31,7 +30,8 @@ function get_console_mode()
return dwMode[]
end
```
Now, compare this to the call without this package:

Compare this to the call without this package:
```julia

function get_console_mode()
Expand All @@ -58,8 +58,7 @@ BOOL WINAPI GetConsoleMode(
);
```

As you can see, the call to these APIs using `WinTypes` is simpler and
directly translatable without manually looking up the myriad Windows data types.
Using `WinTypes` to wrap these APIs is both simpler and more readible, making it easier without having to manually look up the corresponding Windows data types.



Expand Down

0 comments on commit 09d57f8

Please sign in to comment.