Skip to content

pre-release documentation fixes #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mhambre merged 1 commit into from
Mar 29, 2025
Merged

pre-release documentation fixes #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Mailbox - A POSIX Shared Memory Multi-Directional Message Queue
# Mailbox - A POSIX Shared Memory Multi-Directional Message Queue Library
[![Unit Tests](https://github.com/matthambrecht/Mailbox/actions/workflows/run-tests.yaml/badge.svg)](https://github.com/matthambrecht/Mailbox/actions/workflows/run-tests.yaml)
This is a C library to facilitate IPC (interprocess communication) allowing
multi-directional message sharing. It is designed to mimic the organization of postal systems. Made to be thread-safe using POSIX `semaphore.h`.

This is a C library to facilitate IPC (interprocess communication) by allowing
multi-directional message sharing. It is designed to mimic the organization of postal systems and made to be thread-safe using POSIX `semaphore.h`.

## What is IPC (interprocess communication)
"In computer science, interprocess communication (IPC) is the sharing of data between running processes in a computer system. Mechanisms for IPC may be provided by an operating system. Applications which use IPC are often categorized as clients and servers, where the client requests data and the server responds to client requests. Many applications are both clients and servers, as commonly seen in distributed computing." - [Wikipedia/Inter-process Communication](https://en.wikipedia.org/wiki/Inter-process_communication)
Expand Down
4 changes: 4 additions & 0 deletions mailbox.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
/*
mailbox.h - A Unix Shared Memory Mailing System for IPC

Author: Matthew Hambrecht (https://github.com/matthambrecht)
Version: v1.2.0
Documentation: https://github.com/matthambrecht/Mailbox/blob/main/README.md
*/

#ifndef MAILBOX_H
Expand Down