#26 review README and add docs #31
Merged
Conversation
This file contains hidden or 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
Contributor
edmc25
commented
Oct 23, 2025
edmc25
commented
- full review of README, making it more concise as well
- add docs for installing dependencies
- add docs for building OpenXilEnv
- add doc for setup of an external process
- full review of README, making it more concise as well - add docs for installing dependencies - add docs for building OpenXilEnv - add doc for setup of an external process
Contributor
Author
|
Hi @eb1234x, Hi @wernertimothy Take your time to go through all the documents please. This do not have to be merged ASAP. |
wernertimothy
requested changes
Nov 3, 2025
Contributor
wernertimothy
left a comment
wernertimothy
left a comment
There was a problem hiding this comment.
Add these changes for layout clarity
docs/WINDOWS_DEPENDENCIES.md
Outdated
| set "BUILD_ROOT=%SystemDrive%\dev\build" | ||
| ``` | ||
|
|
||
| **Folder layout example:** |
Contributor
There was a problem hiding this comment.
Suggested change
| **Folder layout example:** |
docs/WINDOWS_DEPENDENCIES.md
Outdated
|
|
||
| **Folder layout example:** | ||
|
|
||
| - `%TOOLS_ROOT%\mingw64` — MinGW (niXman, 14.2.0, win32-seh-ucrt) |
Contributor
There was a problem hiding this comment.
Suggested change
| - `%TOOLS_ROOT%\mingw64` — MinGW (niXman, 14.2.0, win32-seh-ucrt) |
docs/WINDOWS_DEPENDENCIES.md
Outdated
| **Folder layout example:** | ||
|
|
||
| - `%TOOLS_ROOT%\mingw64` — MinGW (niXman, 14.2.0, win32-seh-ucrt) | ||
| - `%TOOLS_ROOT%\Qt6_9` — Qt install prefix produced by the build below |
Contributor
There was a problem hiding this comment.
Suggested change
| - `%TOOLS_ROOT%\Qt6_9` — Qt install prefix produced by the build below |
docs/WINDOWS_DEPENDENCIES.md
Outdated
|
|
||
| - `%TOOLS_ROOT%\mingw64` — MinGW (niXman, 14.2.0, win32-seh-ucrt) | ||
| - `%TOOLS_ROOT%\Qt6_9` — Qt install prefix produced by the build below | ||
| - `%TOOLS_ROOT%\OpenXilEnv` — OpenXilEnv install prefix produced by the build below |
Contributor
There was a problem hiding this comment.
Suggested change
| - `%TOOLS_ROOT%\OpenXilEnv` — OpenXilEnv install prefix produced by the build below |
docs/WINDOWS_DEPENDENCIES.md
Outdated
| - `%TOOLS_ROOT%\mingw64` — MinGW (niXman, 14.2.0, win32-seh-ucrt) | ||
| - `%TOOLS_ROOT%\Qt6_9` — Qt install prefix produced by the build below | ||
| - `%TOOLS_ROOT%\OpenXilEnv` — OpenXilEnv install prefix produced by the build below | ||
| - `%SRC_ROOT%\Qt6_9` — Qt source code |
Contributor
There was a problem hiding this comment.
Suggested change
| - `%SRC_ROOT%\Qt6_9` — Qt source code |
docs/WINDOWS_DEPENDENCIES.md
Outdated
| - `%TOOLS_ROOT%\Qt6_9` — Qt install prefix produced by the build below | ||
| - `%TOOLS_ROOT%\OpenXilEnv` — OpenXilEnv install prefix produced by the build below | ||
| - `%SRC_ROOT%\Qt6_9` — Qt source code | ||
| - `%SRC_ROOT%\OpenXilEnv` — OpenXilEnv source code |
Contributor
There was a problem hiding this comment.
Suggested change
| - `%SRC_ROOT%\OpenXilEnv` — OpenXilEnv source code |
docs/WINDOWS_DEPENDENCIES.md
Outdated
| - `%TOOLS_ROOT%\OpenXilEnv` — OpenXilEnv install prefix produced by the build below | ||
| - `%SRC_ROOT%\Qt6_9` — Qt source code | ||
| - `%SRC_ROOT%\OpenXilEnv` — OpenXilEnv source code | ||
| - `%BUILD_ROOT%\Qt6_9` — Qt build directory |
Contributor
There was a problem hiding this comment.
Suggested change
| - `%BUILD_ROOT%\Qt6_9` — Qt build directory |
docs/WINDOWS_DEPENDENCIES.md
Outdated
| - `%SRC_ROOT%\Qt6_9` — Qt source code | ||
| - `%SRC_ROOT%\OpenXilEnv` — OpenXilEnv source code | ||
| - `%BUILD_ROOT%\Qt6_9` — Qt build directory | ||
| - `%BUILD_ROOT%\OpenXilEnv` — OpenXilEnv build directory |
Contributor
There was a problem hiding this comment.
Suggested change
| - `%BUILD_ROOT%\OpenXilEnv` — OpenXilEnv build directory |
edmc25
commented
Nov 6, 2025
Readme.md
Outdated
| XilEnv provides an environment to set up a SiL system on Windows or Linux hosts. It clearly separates its own components from the embedded software under test through a network layer. Each component can run in its own executable, providing memory protection between them. | ||
|
|
||
|  | ||
| Communication between the software under test, models, and XilEnv is done via sockets or (on Windows) Named Pipes / (on Linux) local sockets. These are used for: |
Update docs/LINUX_DEPENDENCIES.md Update docs/Readme.md Co-authored-by: Timothy Werner <69105337+wernertimothy@users.noreply.github.com>
edmc25
force-pushed
the
task/improve-readme
branch
from
86aba90 to
64b17d5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.