README.md

algorithms_and_data_structures

Objectives

• A toy implementation of foundational data structures and algorithms at a lower level of the stack.

Project Structure

• docs: Project documentation lives in here.
• src: Each data structure is an independent module.

Theory

Dependencies

• Docker

Setup Instructions

• The repository is configured to use devcontainers for development.
  • Developing inside a Container

Installation

Clone Repository

git clone git@github.com:praisetompane/algorithms_and_data_structures.git

Build

make build

Test

make test

Install

sudo make install

Uninstall

sudo make uninstall

Usage

#include "array.h"
#include <stdio.h>

int main()
{
    printf("Test creating, adding and reading from Integer Array\n");
    Array numbers = array(INT, 10);

    int number = 2;
    add(&numbers, 0, &number);

    int read_int;
    read(&numbers, 0, &read_int);
    printf("\n");
}

Git Conventions

• NB: the master is locked and all changes must come through a Pull Request.
• commit messages:
  • provide concise commit messages that describe what you have done.

    # example:
    git commit -m "feat(core): algorithm" -m"implement my new shiny faster algorithm"

  • screen shot of Githb view
  • references:
    • https://www.conventionalcommits.org/en/v1.0.0/
    • https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/