simple_allocator

A simple, poorly-performing memory allocator
git clone https://git.bracken.jp/simple_allocator.git
Log | Files | Refs | Submodules | README | LICENSE

README.md (872B)


      1 # Simple allocator
      2 
      3 A simple, poorly-performing memory allocator.
      4 
      5 ## Prerequisites
      6 
      7 To build, you'll need [cmake](https://cmake.org),
      8 [ninja](https://github.com/ninja-build/ninja), and a clang build toolchain
      9 installed on your system.
     10 
     11 ## Obtaining the source
     12 
     13 First, clone the repo; then, initialise and fetch git submodules:
     14 
     15 ```shell
     16 # Initialise local configuration file.
     17 git submodule init
     18 
     19 # Fetch submodules (googletest).
     20 git submodule update
     21 ```
     22 
     23 ## Updating git submodules
     24 
     25 To update the git submodules to a newer commit, simply run:
     26 
     27 ```shell
     28 git submodule update --remote
     29 ```
     30 
     31 ## Building and running
     32 
     33 First, generate the ninja build files:
     34 
     35 ```shell
     36 # For debug build:
     37 cmake -DCMAKE_BUILD_TYPE=Debug -GNinja
     38 
     39 # For release build:
     40 cmake -DCMAKE_BUILD_TYPE=Release -GNinja
     41 ```
     42 
     43 ### Executable binary
     44 
     45 To build and run the binary:
     46 
     47 ```shell
     48 ninja
     49 ./bin/main
     50 ```