Skip to content

Commit 534ac8c

Browse files
committed
docs: readme
1 parent 3745863 commit 534ac8c

File tree

1 file changed

+23
-7
lines changed

1 file changed

+23
-7
lines changed

README.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,27 @@
11
# CommonLibOB64
22

3-
## General Requirements
3+
### Requirements
4+
* [XMake](https://xmake.io) [2.8.2+]
5+
* C++23 Compiler (MSVC, Clang-CL)
46

5-
### Build Dependencies
6-
* [Visual Studio Community 2022 Preview](https://visualstudio.microsoft.com/vs/preview/)
7-
* Desktop development with C++
7+
## Getting Started
8+
```bat
9+
git clone https://github.com/libxse/commonlibob64
10+
cd commonlibob64
11+
```
812

9-
### Development
10-
* [CMake](https://cmake.org/)
11-
* [vcpkg](https://github.com/microsoft/vcpkg)
13+
### Build
14+
To build the project, run the following command:
15+
```bat
16+
xmake build
17+
```
18+
19+
> ***Note:*** *This will generate a `build/windows/` directory in the **project's root directory** with the build output.*
20+
21+
### Project Generation (Optional)
22+
If you want to generate a Visual Studio project, run the following command:
23+
```bat
24+
xmake project -k vsxmake
25+
```
26+
27+
> ***Note:*** *This will generate a `vsxmakeXXXX/` directory in the **project's root directory** using the latest version of Visual Studio installed on the system.*

0 commit comments

Comments
 (0)