-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add initial installation and running tests document
- Loading branch information
1 parent
a955fff
commit 17f2292
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Installation & Running Tests | ||
## 1. Requirements | ||
- Implemented in `C++20` and only uses C++ Standard Library. | ||
- `CMake 3.12` or higher. | ||
- **GNU/Linux:** `GCC 10.1` or higher, `Clang 11` or higher. | ||
- **Windows:** `Visual Studio 2019 version 16.11.14` or higher. | ||
- **macOS:** `Xcode 14.3` or higher. | ||
|
||
## 2. Installation | ||
To use the library, simply clone the repository or [download](../include/bytepack/bytepack.hpp) the `bytepack.hpp` file and include it in your project. | ||
```bash | ||
git clone https://github.com/farukeryilmaz/bytepack.git | ||
``` | ||
Include the library in your C++ project: | ||
```cpp | ||
#include "bytepack/bytepack.hpp" | ||
``` | ||
|
||
## 3. Building and Testing | ||
Clone the repository with submodule `Catch2 v2.x` to run tests: | ||
```bash | ||
git clone --recursive https://github.com/farukeryilmaz/bytepack.git | ||
``` | ||
> If you cloned non-recursively previously, use `git submodule update --init` to clone the necessary submodules. | ||
### 3.1 Visual Studio | ||
(incomplete) |