# c-project-structure

Project description

Project image/gif

## Requirements

Requirements

RHEL-like:
`sudo dnf install readline-devel`

Debian[12]:
`sudo apt install build-essential libreadline-dev make`

## Building from source

One Liner for Debain-based distros:
` sudo apt install build-essential libreadline-dev make git; git clone https://git.stephenltoth.com/icaema/colorwrap.git; cd colorwrap; make;`

Run: `bin/cterm /bin/sh`

## Installation

Normal Build: `make`

Debug Build: `make debug`

## Usage

`make test`

## Considerations and Caveats

Since this program buffers input by line, It will not handle TUI-based commands
    Examples include less and vim

If you need to use these kinds of applications, do not use this program to wrap your shell.

## Example


## Documentation

Location of Documentation

## Directory structure
```
|-- Makefile           <- Project makefile
|-- README             <- Project README
|-- bin                <- Compiled binaries
|   `-- run            <- Project main executable
|-- build              <- Static objects and intermediate files
|-- data               <- Project data
|   |-- raw            <- Raw data
|   |-- interim        <- Interm data
|   |-- input          <- Input data
|   |-- output         <- Output data
|-- docs               <- Documentation
|-- include            <- Header files
|-- lib                <- Dynamic objects
|-- src                <- Source files
`-- tests              <- Unit tests
```