Skip to content
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.

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

Fixed outdated readme instructions/script to build and run unit tests #644

Merged
merged 1 commit into from
Dec 21, 2022
Merged
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion test/unit-test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Go to the root directory of the FreeRTOS+TCP repo and run the following script:
#!/bin/bash
# This script should be run from the root directory of the FreeRTOS+TCP repo.
if [[ ! -f FreeRTOS_IP.c ]]; then
if [[ ! -d source ]]; then
echo "Please run this script from the root directory of the FreeRTOS+TCP repo."
exit 1
fi
Comment on lines 33 to 39
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Non-Blocking: Why not just make this as an actual shell script in the root directory?

Copy link
Member Author

@tony-josi-aws tony-josi-aws Dec 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kstribrnAmzn Not sure if this is something that is frequently used/required by the normal users.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally agree with the idea of making these actual scripts that live in the repo instead of something that needs to be copy/pasted. But I think doing this is a standard across a few of our repos. Additionally, I'm not sure if we want to make a decision to add it as a file as part of this PR.

Expand Down