Skip to content

Commit 7896bb0

Browse files
committed
Update readme
1 parent 90d21c1 commit 7896bb0

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@
77

88
Replace malloc/free with xmalloc/xfree is faster than the global heap and prevents heap fragmentation faults.
99

10+
Originally published on CodeProject at: <a href="https://www.codeproject.com/Articles/1084801/Replace-malloc-free-with-a-Fast-Fixed-Block-Memory"><strong>Replace malloc/free with a Fast Fixed Block Memory Allocator</strong></a>
11+
1012
# Table of Contents
1113

1214
- [Replace malloc/free with a Fast Fixed Block Memory Allocator](#replace-mallocfree-with-a-fast-fixed-block-memory-allocator)
1315
- [Table of Contents](#table-of-contents)
14-
- [Preface](#preface)
16+
- [Getting Started](#getting-started)
1517
- [Introduction](#introduction)
1618
- [Storage Recycling](#storage-recycling)
1719
- [Heap vs. Pool](#heap-vs-pool)
@@ -27,11 +29,14 @@ Replace malloc/free with xmalloc/xfree is faster than the global heap and preven
2729
- [Conclusion](#conclusion)
2830

2931

30-
# Preface
32+
# Getting Started
3133

32-
Originally published on CodeProject at: <a href="https://www.codeproject.com/Articles/1084801/Replace-malloc-free-with-a-Fast-Fixed-Block-Memory"><strong>Replace malloc/free with a Fast Fixed Block Memory Allocator</strong></a>
34+
[CMake](https://cmake.org/) is used to create the project build files on any C++ system including Windows, Linux, or an embedded system.
3335

34-
<p><a href="https://www.cmake.org/">CMake</a>&nbsp;is used to create the build files. CMake is free and open-source software. Windows, Linux and other toolchains are supported. See the <strong>CMakeLists.txt </strong>file for more information.</p>
36+
1. Clone the repository.
37+
2. From the repository root, run the following CMake command:
38+
`cmake -B Build .`
39+
3. Build and run the project within the `Build` directory.
3540

3641
# Introduction
3742

0 commit comments

Comments
 (0)