mirror/uuid_v4
2
0
Fork 0
mirror of https://github.com/crashoz/uuid_v4.git synced 2024-11-27 02:59:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improved Readme

Browse Source
This commit is contained in:
Xavier 'crashoz' Launey 2023-03-16 14:10:11 +01:00
parent 46762f3614
commit 336ffae2c6
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -13,7 +13,27 @@ The namespace changed from `UUID` to `UUIDv4` to avoid a conflict with a windows
## Usage
### Cmake
```
mkdir build && cd build
cmake -DCMAKE_INSTALL_PREFIX="/usr/local" ..
cmake --install .
```
Then use
```
find_package(uuid_v4)
target_link_libraries(MyProject uuid_v4::uuid_v4)
```
### Manually
Include `"uuid_v4.h"` and `"endianness.h"`.
## Documentation
To start generating UUIDs you need to create an object `UUIDv4::UUIDGenerator<random_generator>` where random_generator is a c\++11 Random number engine (see [random]).
It is highly recommended to use the default engine `std::mt19937_64` as it has a SIMD implementation (at least in libstdc++) and provides better randomness.
@ -117,6 +137,9 @@ If you do not have googletest and googlebenchmark installed globally
```
git clone --recurse-submodules https://github.com/crashoz/uuid_v4.git
```
If you want to run the benchmark against the other libraries you need to install them (`libuuid` and `boost`)
otherwise
```
git clone https://github.com/crashoz/uuid_v4.git
@ -127,7 +150,7 @@ Then build
mkdir build
cd build
cmake -Dtest=ON -Dbenchmark=ON ..
make
cmake --build .
./tests/uuid_v4_test
./benchmarks/uuid_v4_benchmark
```