This PR was focused on adding the DLL capability to the examples. It fully fleshes out the work with documentation on how to run the program. There is some refactoring as to make sure the main README is the single source of installations and the other two examples follow from them. To be clear, this program creates a .dll and also creates an .exe to show that the DLL can be executed
Requirements
PR #6 is required for this to be run successfully.
See README.md to see how to download the following requirements:
Anaconda
Visual Studio 2022
Issues Referenced
Fixes #5
Documentation update
README.md
README_py.md
README_of.md
The README now includes the installation steps that both other README's point to. The README.md is also updated to point to ther other examples. README_of.md is created and is on it's first iteration for examples.
Notes for Reviewer
This is a much larger PR in terms of rescoping the project. It has some changes to streamline the user experience reflected in the README.md changes.
This adds a .dll mode to the program which can be seen with the .dll that is created for rounder. This serves as a precursor to adding this capability inside the software itself.
It also adds the documentation to run this mode to the program. There are other small changes to the python version, but nothing that needs to be reviewed.
Keep in mind that some of these changes are part of PR #6 if there is anything to comment on these changes please put them on that PR.
Note: I have not considered how the additional code effects the Python example. This is something I have realized and will look to fix once PR #6 is merged.
Testing
To test: make sure to run through the entire README pipeline from start to finish. This means following the README.md instructions, than following the instructions in README_of.md.
Note: the README_py.md does not need to be tested for this PR.
If there are any problems following the instructions or the program does not print 5 successfully the test failed, otherwise the test was a success.
Results
The program should output 5, the rounded number in driver.cpp. This is done after creating the .dll and using it to create a .exe file. Running this file is what should output 5 on the command line, as shown in the README_of.md associated with this example. There is no capability for the user to input a number currently, which is a possible future change.
Feature Tests
N/A
Checklist to allow merge
[ ] All dependent repositories used were on branch master
Description
This PR was focused on adding the DLL capability to the examples. It fully fleshes out the work with documentation on how to run the program. There is some refactoring as to make sure the main README is the single source of installations and the other two examples follow from them. To be clear, this program creates a .dll and also creates an .exe to show that the DLL can be executed
Requirements
Issues Referenced
Documentation update
README.md README_py.md README_of.md The README now includes the installation steps that both other README's point to. The README.md is also updated to point to ther other examples. README_of.md is created and is on it's first iteration for examples.
Notes for Reviewer
Testing
To test: make sure to run through the entire README pipeline from start to finish. This means following the README.md instructions, than following the instructions in README_of.md. Note: the README_py.md does not need to be tested for this PR. If there are any problems following the instructions or the program does not print 5 successfully the test failed, otherwise the test was a success.
Results
The program should output 5, the rounded number in driver.cpp. This is done after creating the .dll and using it to create a .exe file. Running this file is what should output 5 on the command line, as shown in the README_of.md associated with this example. There is no capability for the user to input a number currently, which is a possible future change.
Feature Tests
N/A
Checklist to allow merge
master