Added a little help in README.md #6
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bigbrett
requested changes
May 28, 2024
|
|
||
| <intro on what the posix example is> | ||
| ### Posix TCP server and client |
There was a problem hiding this comment.
@jackctj117 could you provide a little blurb summarizing what the POSIX TCP server and client is/does? (e.g. spins up a wolfHSM server in the server thread, client in the client thread, then runs the unit tests on the client side against the server)
There was a problem hiding this comment.
Added a short description and fixed all other minor request.
README.md
Outdated
| <steps to build wh_server_tcp> | ||
| ### Executables | ||
| Once both the server and the client `.elf` files have been made the example can now be ran. In the root directory for wolfHSM-examples run `./posix/tcp/wh_server_tcp/Build/wh_server_tcp.elf`. | ||
| In a sperate instnace run `./posix/tcp/wh_client_tcp/Build/wh_client_tcp.elf` out of the root directory for wolfHSM-examples for the client. |
There was a problem hiding this comment.
Suggested change
| In a sperate instnace run `./posix/tcp/wh_client_tcp/Build/wh_client_tcp.elf` out of the root directory for wolfHSM-examples for the client. | |
| In a sperate instance run `./posix/tcp/wh_client_tcp/Build/wh_client_tcp.elf` out of the root directory for wolfHSM-examples for the client. |
might be a few other Typos too
README.md
Outdated
| ### Building wh_server_tcp | ||
| cd into `wolfHSM-examples/posix/tcp/wh_server_tcp`, next `make`. Once completed an `.elf` executable will be made in `Build` named `wh_server_tcp.elf`. |
There was a problem hiding this comment.
Suggested change
| cd into `wolfHSM-examples/posix/tcp/wh_server_tcp`, next `make`. Once completed an `.elf` executable will be made in `Build` named `wh_server_tcp.elf`. | |
| `cd` into `wolfHSM-examples/posix/tcp/wh_server_tcp`, next `make`. Once completed an `.elf` executable will be made in `Build` named `wh_server_tcp.elf`. |
README.md
Outdated
| cd into `wolfHSM-examples/posix/tcp/wh_server_tcp`, next `make`. Once completed an `.elf` executable will be made in `Build` named `wh_server_tcp.elf`. | ||
|
|
||
| ### Building wh_client_tcp | ||
| Building the client will follow the same steps as the building the server. cd into `wolfHSM-examples/posix/tcp/wh_client_tcp`, next `make`. Once completed an `.elf` executable will be made in `Build` named `wh_client_tcp.elf`. |
There was a problem hiding this comment.
Suggested change
| Building the client will follow the same steps as the building the server. cd into `wolfHSM-examples/posix/tcp/wh_client_tcp`, next `make`. Once completed an `.elf` executable will be made in `Build` named `wh_client_tcp.elf`. | |
| Building the client will follow the same steps as the building the server. `cd` into `wolfHSM-examples/posix/tcp/wh_client_tcp`, next `make`. Once completed an `.elf` executable will be made in `Build` named `wh_client_tcp.elf`. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added contents to README.md, only added a little mostly just mentioning what the example is and making sure the users Makefile has the correct directory name for wolfHSM.