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.

Sign up for GitHub

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

[docs] Update notes in docs #42

Merged
merged 1 commit into from
Feb 17, 2025
Merged

[docs] Update notes in docs #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion docs/build/quick_start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ cmake --preset debug-conan
cmake --build --preset debug
```

Note: By default, configure preset `debug` enables building scp-machine tests.
!!! Note
By default, configure preset `debug` enables building scp-machine tests.

#### Run scp-machine tests in Debug

Expand Down
5 changes: 3 additions & 2 deletions docs/quick_start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@

### GitHub Releases

Note: currently, using scp-machine natively on Windows isn't supported.
!!! Note
Currently, using scp-machine natively on Windows isn't supported.

1. Download pre-built artifacts of sc-machine from [GitHub Releases](https://github.com/ostis-ai/sc-machine/releases) and extract it to any location.

To learn more about how to install and use sc-machine artifacts, see [sc-machine quick start](https://ostis-ai.github.io/sc-machine/quick_start/).
To learn more about how to install and use sc-machine artifacts, see [sc-machine quick start](https://ostis-ai.github.io/sc-machine/quick_start).

2. Download pre-built artifacts of scp-machine from [GitHub Releases](https://github.com/ostis-ai/scp-machine/releases) and extract it to any location.

Expand Down
Loading