Skip to content

Commit fc7f5db

Browse files
committed
docs: more build details
makin it easy
1 parent 3bba418 commit fc7f5db

1 file changed

Lines changed: 19 additions & 7 deletions

File tree

docs/contributing.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,18 @@
3737

3838
### Windows
3939

40-
- Visual Studio 2019 or later
41-
- MSVC Toolset v142
42-
- Configure SDK version in `src/SourceAutoRecord.vcxproj`
43-
- Configure paths in `copy.bat`
40+
- [Visual Studio Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) or [Visual Studio](https://visualstudio.microsoft.com/)
41+
- Windows Universal C Runtime
42+
- C++ Build Tools core features
43+
- Windows 10 SDK (10.0.19041.0 or newer)
44+
- MSVC v142 - VS 2019 C++ x64/x86 build tools
45+
- Add MSBuild to PATH (`Visual Studio/xx/BuildTools/MSBuild/Current/Bin`) or use Visual Studio GUI
46+
- Configure SDK version in `src/SourceAutoRecord.vcxproj` (`10.0`) (don't commit this change)
47+
- Configure paths in `copy.bat` (`git update-index --assume-unchanged copy.bat`)
48+
49+
```pwsh
50+
msbuild -m -p:Platform=x86
51+
```
4452

4553
### Linux
4654

@@ -49,13 +57,17 @@
4957
- Make 4.1
5058
- Configure paths in `config.mk`
5159

60+
```bash
61+
make -j${nproc}
62+
```
63+
5264
## Pull Requests
5365

5466
- Write a meaningful title and a short description
5567
- Follow the [coding style](#coding-style)
5668
- Follow the requested changes
5769
- DO NOT stage files that you had to configure
58-
- Use the latest `master` branch
70+
- Use the latest `master` branch as a base
5971

6072
### Quick Tutorial with git
6173

@@ -309,9 +321,9 @@ Note: Keep a static version of a variable if it can be accessed more than once.
309321
Commands should always return a useful message if something went wrong.
310322
311323
```cpp
312-
CON_COMMAND(sar_hello, "Useful help description.\n") {
324+
CON_COMMAND(sar_hello, "sar_hello <name> - Useful help description.\n") {
313325
if (args.ArgC() != 2) {
314-
return console->Print("Please enter a string!\n");
326+
return console->Print(sar_hello.ThisPtr()->m_pszHelpString);
315327
}
316328
317329
console->Print("Hello %s!\n", args[1]);

0 commit comments

Comments
 (0)