Merge pull request #6 from cm-jones/develop

Develop

Author: cm-jones

.github/actions/package/action.yaml

@@ -2,7 +2,7 @@ name: "Package libdsc"
 description: "Build Debian, RPM, and Arch Linux packages"
 inputs:
   distribution:
-    description: "Distribution to build package for (debian, rpm, or arch)"
+    description: "Distribution to build package for (Debian, rpm, or Arch)"
     required: true
   version:
     description: "Version tag (e.g., v0.1.0-alpha)"
@@ -76,7 +76,7 @@ runs:
       shell: bash
       run: |
         cd ${{ github.workspace }}
-        ./scripts/build-debian.sh
+        ./scripts/debian.sh
 
     - if: inputs.distribution == 'rpm'
       name: Setup RPM packaging environment
@@ -88,7 +88,7 @@ runs:
           bash -c "dnf install -y rpm-build rpmdevtools cmake gcc make && \
                   useradd -m builder && \
                   chown -R builder:builder . && \
-                  su builder -c './scripts/build-rpm.sh'"
+                  su builder -c './scripts/rpm.sh'"
 
     - if: inputs.distribution == 'arch'
       name: Update PKGBUILD version

.github/workflows/ci.yaml

@@ -3,6 +3,7 @@ on:
   push:
     branches:
       - main
+      - develop
   pull_request:
     branches:
       - main

.github/workflows/release.yaml

@@ -1,4 +1,4 @@
-name: Create a new release
+name: Release
 on:
   push:
     tags: ['v*.*.*']

CONTRIBUTING.md

@@ -4,7 +4,7 @@
 
 1. Clone the repository:
 ```bash
-git clone https://github.com/yourusername/libdsc.git
+git clone https://github.com/cm-jones/libdsc.git
 cd libdsc
 ```
 
@@ -13,36 +13,41 @@ cd libdsc
 ## Building and Testing
 
 ### Basic Build
+
 ```bash
 ./scripts/build.sh
 ```
 
 ### Run Tests
+
 ```bash
 ./scripts/build.sh
 cd build
 ctest --output-on-failure
 ```
 
 ### Run Linter
+
 ```bash
 ./scripts/lint.sh
 ```
 
 ### Format Code
+
 ```bash
 ./scripts/format.sh
 ```
 
 ## Package Management
 
 ### Official Releases
+
 The recommended way to create releases is through GitHub:
 
 1. Tag your version:
 ```bash
-git tag v0.1.0-alpha
-git push origin v0.1.0-alpha
+git tag v0.1.0
+git push origin v0.1.0
 ```
 
 2. GitHub Actions will automatically:
@@ -55,9 +60,11 @@ git push origin v0.1.0-alpha
 This ensures consistent, reproducible builds in a clean environment.
 
 ### Local Package Testing
+
 For development and testing, you can build packages locally in the dev container:
 
 #### Debian Package
+
 ```bash
 ./scripts/build-debian.sh
 ```
@@ -66,6 +73,7 @@ Outputs:
 - libdsc-dev_*.deb (development)
 
 #### RPM Package
+
 ```bash
 ./scripts/build-rpm.sh
 ```
@@ -78,6 +86,7 @@ Requirements:
 - rpm-build and rpmdevtools packages
 
 #### Arch Package
+
 ```bash
 ./scripts/build-arch.sh
 ```
@@ -104,10 +113,11 @@ Note: Local package builds are useful for testing but should not be distributed.
    - Single package with both runtime and development files
 
 ### Version Numbering
-- Release tags: v0.1.0-alpha
-- Debian format: 0.1.0~alpha1
-- RPM format: 0.1.0~alpha
-- Arch format: 0.1.0_alpha
+
+- Release tags: v0.1.0
+- Debian format: 0.1.0
+- RPM format: 0.1.0
+- Arch format: 0.1.0
 
 ## Adding New Features
 

Doxyfile

@@ -1,32 +1,34 @@
-<p align="center">
-  <img src="assets/logo.png" alt="logo" width="200" height="200" style="vertical-align: middle;">
+<p align="center" style="margin: 0; padding: 0;">
+  <img src="assets/logo.png" alt="libdsc logo" width="200" height="200" style="vertical-align: middle;">
 </p>
 
 # libdsc
 
 [![CI](https://github.com/cm-jones/libdsc/actions/workflows/ci.yaml/badge.svg)](https://github.com/cm-jones/libdsc/actions/workflows/ci.yaml)
-[![Benchmarks](https://github.com/cm-jones/libdsc/actions/workflows/benchmark.yaml/badge.svg)](https://github.com/cm-jones/libdsc/actions/workflows/benchmark.yaml)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/cb3382e664b54cb7b1f023424fcc774c)](https://app.codacy.com/gh/cm-jones/libdsc/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Codecov](https://codecov.io/gh/cm-jones/libdsc/branch/main/graph/badge.svg)](https://codecov.io/gh/cm-jones/libdsc)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 
-libdsc is an open-source C library featuring generic implementations of some C++ Standard Library containers. 
+`libdsc` is an open-source C library featuring generic and memory-safe implementations of various containers provided by the C++ Standard Library.
 
 ## Features
 
-- **Vector**: Dynamically-sized array
-- **Forward List**: Singly-linked list
-- **List**: Doubly-linked list
-- **Stack**: LIFO container
-- **Queue**: FIFO container
-- **Unordered Map**: Hash table for key-value pairs
-- **Unordered Set**: Hash table for unique elements
+`libdsc` implements the following containers:
 
-All of these implementations are:
+- `vector`: dynamically-sized array
+- `forward_list`: singly-linked list
+- `list`: doubly-linked list
+- `stack`: LIFO container
+- `queue`: FIFO container
+- `unordered_map`: hash table for key-value pairs
+- `unordered_set`: hash table for unique elements
+
+All containers are:
 
 - Generic (can store any data type)
 - Memory safe (with proper error handling)
 - Thoroughly tested
-- Performance benchmarked against C++ counterparts
+- Benchmarked against C++ Standard Library counterparts
 
 ## Installing from source
 
@@ -39,10 +41,9 @@ cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=OFF -DBUILD_BENCHMARKS=OFF -DB
 make
 ```
 
-Then, install the library system-wide:
+Then, to install the library system-wide:
 
 ```bash
-cd build
 sudo make install
 ```
 
@@ -52,17 +53,33 @@ This will install:
 - Header files to `/usr/local/include/libdsc`
 - CMake configuration files to `/usr/local/lib/cmake/libdsc`
 
+## Installing from package
+
+On Debian-based Linux distributions:
+
+```bash
+sudo dpkg -i libdsc-<current_version>.deb
+```
+
+On RPM-based Linux distributions:
+
+```bash
+
+```
+
 ## Usage
 
 ```c
 #include <libdsc/vector.h>
 #include <libdsc/list.h>
 
+// Include other containers as needed ...
+
 #include <stdio.h>
 
-int main() {
+int main(int argc, char *argv[]) {
     // Create a vector of integers
-    dsc_vector_t *vec = vector_create(sizeof(int));
+    dsc_vector *vec = vector_create(sizeof(int));
 
     // Push some values
     for (size_t i = 0; i < 5; ++i) {
@@ -79,7 +96,7 @@ int main() {
     vector_destroy(vec);
 
     // Create a list of integers
-    dsc_list_t *list = list_create(sizeof(int));
+    dsc_list *list = list_create(sizeof(int));
 
     // Push some values
     for (size_t i = 0; i < 5; ++i) {
@@ -97,15 +114,15 @@ int main() {
     // Clean up
     list_destroy(list);
 
-    return 0;
+    return EXIT_SUCCESS;
 }
 ```
 
 More examples can be found in the `examples` directory.
 
 ## Testing
 
-libdsc uses Google Test for unit testing. To run the tests:
+Google Test is used for unit testing. To run the tests, after building the project:
 
 ```bash
 cd build
@@ -114,7 +131,7 @@ ctest --output-on-failure
 
 ## Benchmarking
 
-Google Benchmark is used for benchmarking libdsc containers against the equivalent containers in the C++ Standard Library. Benchmarks are run weekly and can be found in the [Actions tab](https://github.com/cm-jones/libdsc/actions/workflows/benchmark.yaml) under the Benchmarks workflow. You can also run benchmarks locally:
+Google Benchmark is used to measure the performance of libdsc's containers against their equivalents in the C++ Standard Library. Benchmarks are run weekly automatically via GitHub Actions.  You can also run the benchmarks locally:
 
 ```bash
 mkdir -p build
@@ -127,8 +144,8 @@ cd benchmarks
 
 ## Contributing
 
-See [CONTRIBUTING.md](CONTRIBUTING.md).
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) carefully before you attempt to make contributions to this project.
 
 ## License
 
-This project is licensed under the GPLv3. See [LICENSE](LICENSE) for details.
+`libdsc` is licensed under the GPLv3. See [LICENSE](LICENSE) for details.

README.md

@@ -0,0 +1,11 @@
+# libdsc Roadmap
+
+Containers from the C++ Standard Library yet to be implemented:
+
+[ ] - `std::map`
+[ ] - `std::set`
+[ ] - `std::multimap`
+[ ] - `std::multiset`
+[ ] - `std::array`
+
+

ROADMAP.md

@@ -6,7 +6,7 @@
 
 // Benchmark push_front
 static void BM_ForwardListPushFront(benchmark::State &state) {
-    dsc_forward_list_t *list = forward_list_create(sizeof(int));
+    dsc_forward_list *list = forward_list_create(sizeof(int));
 
     for (auto _ : state) {
         int value = 42;
@@ -30,7 +30,7 @@ BENCHMARK(BM_StdForwardListPushFront)->Range(1, 1 << 20);
 
 // Benchmark push_front and pop_front
 static void BM_ForwardListPushPopFront(benchmark::State &state) {
-    dsc_forward_list_t *list = forward_list_create(sizeof(int));
+    dsc_forward_list *list = forward_list_create(sizeof(int));
 
     for (auto _ : state) {
         int value = 42;
@@ -55,7 +55,7 @@ BENCHMARK(BM_StdForwardListPushPopFront)->Range(1, 1 << 20);
 
 // Benchmark front access
 static void BM_ForwardListFront(benchmark::State &state) {
-    dsc_forward_list_t *list = forward_list_create(sizeof(int));
+    dsc_forward_list *list = forward_list_create(sizeof(int));
     int value = 42;
     forward_list_push_front(list, &value);
 
@@ -80,7 +80,7 @@ BENCHMARK(BM_StdForwardListFront)->Range(1 << 10, 1 << 20);
 
 // Benchmark insert_after
 static void BM_ForwardListInsertAfter(benchmark::State &state) {
-    dsc_forward_list_t *list = forward_list_create(sizeof(int));
+    dsc_forward_list *list = forward_list_create(sizeof(int));
     int value = 42;
     forward_list_push_front(list, &value);
     forward_list_node_t *pos = forward_list_begin(list);
@@ -108,7 +108,7 @@ BENCHMARK(BM_StdForwardListInsertAfter)->Range(1, 1 << 20);
 
 // Benchmark size operation
 static void BM_ForwardListSize(benchmark::State &state) {
-    dsc_forward_list_t *list = forward_list_create(sizeof(int));
+    dsc_forward_list *list = forward_list_create(sizeof(int));
     int value = 42;
     for (size_t i = 0; i < 1000; ++i) {
         forward_list_push_front(list, &value);
@@ -138,7 +138,7 @@ BENCHMARK(BM_StdForwardListSize)->Range(1 << 10, 1 << 20);
 
 // Benchmark empty check
 static void BM_ForwardListEmpty(benchmark::State &state) {
-    dsc_forward_list_t *list = forward_list_create(sizeof(int));
+    dsc_forward_list *list = forward_list_create(sizeof(int));
 
     for (auto _ : state) {
         benchmark::DoNotOptimize(forward_list_empty(list));
@@ -160,7 +160,7 @@ BENCHMARK(BM_StdForwardListEmpty)->Range(1 << 10, 1 << 20);
 
 // Benchmark erase_after operation
 static void BM_ForwardListEraseAfter(benchmark::State &state) {
-    dsc_forward_list_t *list = forward_list_create(sizeof(int));
+    dsc_forward_list *list = forward_list_create(sizeof(int));
     int value = 42;
     forward_list_push_front(list, &value);
     forward_list_node_t *pos = forward_list_begin(list);
@@ -195,7 +195,7 @@ BENCHMARK(BM_StdForwardListEraseAfter)->Range(1 << 10, 1 << 20);
 
 // Benchmark clear operation
 static void BM_ForwardListClear(benchmark::State &state) {
-    dsc_forward_list_t *list = forward_list_create(sizeof(int));
+    dsc_forward_list *list = forward_list_create(sizeof(int));
     int value = 42;
 
     for (auto _ : state) {
@@ -232,7 +232,7 @@ BENCHMARK(BM_StdForwardListClear)->Range(1 << 10, 1 << 20);
 
 // Benchmark iterator operations (begin/end traversal)
 static void BM_ForwardListTraversal(benchmark::State &state) {
-    dsc_forward_list_t *list = forward_list_create(sizeof(int));
+    dsc_forward_list *list = forward_list_create(sizeof(int));
     int value = 42;
     for (size_t i = 0; i < 1000; ++i) {
         forward_list_push_front(list, &value);