R3944Realms/srs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
haibo.chen 2025-10-23 14:13:47 +08:00
parent f962de0125
commit 33c18ff893
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.augmentignore
View File

@ -41,4 +41,4 @@
**/usr/** **/usr/**
**/.github/** **/.github/**
**/gdb/** **/gdb/**
**/ide/** **/cmake/**

14
.vscode/README.md vendored
View File

@ -17,26 +17,26 @@ Run commmand to configure the project by pressing `Command+Shift+P`, then type `
then select `Clang` as the toolchain. Or run the command manually in terminal: then select `Clang` as the toolchain. Or run the command manually in terminal:
```bash ```bash
cmake -S $HOME/git/srs/trunk/ide/srs_clion -B $HOME/git/srs/trunk/ide/vscode-build cmake -S $HOME/git/srs/trunk/cmake -B $HOME/git/srs/trunk/cmake/build
``` ```
> Note: Sometimes it may fail to configure when building libsrtp. Just retry, and it will succeed. > Note: Sometimes it may fail to configure when building libsrtp. Just retry, and it will succeed.
> Note: Make sure you have `xcode` installed, and run `xcode-select --install` to setup the toolchains. > Note: Make sure you have `xcode` installed, and run `xcode-select --install` to setup the toolchains.
> Note: The `settings.json` is used to configure the cmake. It will use `$HOME/git/srs/trunk/ide/srs_clion/CMakeLists.txt` > Note: The `settings.json` is used to configure the cmake. It will use `$HOME/git/srs/trunk/cmake/CMakeLists.txt`
> and `$HOME/git/srs/trunk/ide/vscode-build` as the source file and build directory. > and `$HOME/git/srs/trunk/cmake/build` as the source file and build directory.
Click the `Run > Run Without Debugging` or `Run > Start Debugging` from menu to start or Click the `Run > Run Without Debugging` or `Run > Start Debugging` from menu to start or
debug the server. It will invoke the `build` task defined in `tasks.json`, or you can run debug the server. It will invoke the `build` task defined in `tasks.json`, or you can run
it manually: it manually:
```bash ```bash
cmake --build $HOME/git/srs/trunk/ide/vscode-build cmake --build $HOME/git/srs/trunk/cmake/build
``` ```
> Note: The `launch.json` is used for running and debugging. The build will output the binary to > Note: The `launch.json` is used for running and debugging. The build will output the binary to
> `$HOME/git/srs/trunk/ide/vscode-build/srs`. > `$HOME/git/srs/trunk/cmake/build/srs`.
## macOS: SRS UTest ## macOS: SRS UTest
@ -51,7 +51,7 @@ Run commmand to configure the project by pressing `Command+Shift+P`, then type `
then select `Clang` as the toolchain. Or run the command manually in terminal: then select `Clang` as the toolchain. Or run the command manually in terminal:
```bash ```bash
cmake -S $HOME/git/srs/trunk/ide/srs_clion -B $HOME/git/srs/trunk/ide/vscode-build cmake -S $HOME/git/srs/trunk/cmake -B $HOME/git/srs/trunk/cmake/build
``` ```
> Note: Sometimes it may fail to configure when building libsrtp. Just retry, and it will succeed. > Note: Sometimes it may fail to configure when building libsrtp. Just retry, and it will succeed.
@ -60,7 +60,7 @@ Afterwards, build the utest by pressing `Command+Shift+P`, then type `CMake: Bui
build command. It will invoke the `build` task defined in `tasks.json`, or you can run it manually: build command. It will invoke the `build` task defined in `tasks.json`, or you can run it manually:
```bash ```bash
cmake --build $HOME/git/srs/trunk/ide/vscode-build cmake --build $HOME/git/srs/trunk/cmake/build
``` ```
Then you will discover all the unit testcases from the `View > Testing` panel. You can Then you will discover all the unit testcases from the `View > Testing` panel. You can