Skip to content

Commit 4df5059

Browse files
committed
docs: readme
1 parent 498de5c commit 4df5059

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# CommonLibF4
22

33
### Requirements
4-
* [XMake](https://xmake.io) [2.8.2+]
4+
* [XMake](https://xmake.io) [3.0.0+]
55
* C++23 Compiler (MSVC or Clang-CL)
66

77
## Getting Started
@@ -19,13 +19,20 @@ xmake build
1919
> ***Note:*** *This will generate a `build/windows/` directory in the **project's root directory** with the build output.*
2020
2121
### Project Generation (Optional)
22-
If you want to generate a Visual Studio project, run the following command:
22+
If you use Visual Studio, run the following command:
2323
```bat
2424
xmake project -k vsxmake
2525
```
2626

2727
> ***Note:*** *This will generate a `vsxmakeXXXX/` directory in the **project's root directory** using the latest version of Visual Studio installed on the system.*
2828
29+
**Alternatively**, if you do not use Visual Studio, you can generate a `compile_commands.json` file for use with a laguage server like clangd in any code editor that supports it, like vscode:
30+
```bat
31+
xmake project -k compile_commands
32+
```
33+
34+
> ***Note:*** *You must have a language server extension installed to make use of this file. I recommend `clangd`. Do not have more than one installed at a time as they will conflict with each other. I also recommend installing the `xmake` extension if available to make building the project easier.*
35+
2936
## Notes
3037

3138
CommonLibF4 is intended to replace F4SE as a static dependency. However, the runtime component of F4SE is still required.

0 commit comments

Comments
 (0)