https://github.com/yamtaldev/linear-datastructures
This repository houses C Linear data structures implementations. Each Implementation is organized in the include test and src folder.
https://github.com/yamtaldev/linear-datastructures
Last synced: about 1 year ago
JSON representation
This repository houses C Linear data structures implementations. Each Implementation is organized in the include test and src folder.
- Host: GitHub
- URL: https://github.com/yamtaldev/linear-datastructures
- Owner: YamtalDev
- License: mit
- Created: 2023-09-06T08:03:06.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-05T10:12:10.000Z (almost 3 years ago)
- Last Synced: 2025-03-22T04:23:47.167Z (over 1 year ago)
- Language: C
- Size: 35.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Linear-DataStructures
This repository houses C Linear data structures implementations. Each Implementation is organized in the include test and src folders.
## Overview
This repository serves as a C data structures source implementations. Each data
structure implementation is accompanied by a set of files that
make it easy to build, run, debug, and clean the project.
## Getting Started
* If you'd like to use one of the data structures in this repository, follow these simple steps:
```shell
$ git clone https://github.com/YamtalDev/Linear-DataStructures.git
$ cd "/test/"data_structure_name"
$ make && make run
```
## The structure of the folder is:
```shell
├── Linear-DataStructures/
│ ├── bin/
│ │ ├── executables/
│ │ ├── objects/
│ │ ├── shared_libs/
│ │ └── static_libs/
│ |
| ├── include/
│ │ └── Header files
| |
│ ├── src/
│ │ └── src files
| |
│ ├── test/
│ │ ├── makefile
│ │ └──test file
```
### Inside the implementation folder `/test/"data_structure_name"`, you'll find the following files:
- data_structure_name_test.c: A test file for testing the implementation.
- Makefile: A Makefile to automate compilation, running, debugging, and cleaning.
### Inside the Include folder you'll find:
- data_structure_name.h: The header file containing the necessary declarations.
### Inside the src folder you'll find:
- data_structure_name.c: The C source file with the implementation.
## Usage
To compile, run, debug, or clean the project, you can use the provided Makefile
with the following commands:
```shell
# Simple compilation
$ make
# Running the project
$ make run
# Debugging the project
$ make debug
# Deleting all the obj, exe, shared/static libs files
$ make clean
# Checking valgrind on the project
$ make vlg
# Release compilation with optimization -O3
$ make release
```
These simple commands streamline the development process and make it easy to work
with each project in this repository.
## Contact
For any questions about the project:
### Name: Tal Aharon
### Email: tal.aharon.work@gmail.com