Merge pull request #23 from hu-macsy/version_1_release

Version 1: Release -> preparation

Author: c-bebop

CMakeLists.txt

@@ -2,7 +2,7 @@
 cmake_minimum_required(VERSION 3.14)
 
 # Set project name and version
-project(gdsb VERSION 0.2.0 LANGUAGES CXX)
+project(gdsb VERSION 1.0.0 LANGUAGES CXX)
 
 include(GNUInstallDirs)
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Modeling and Analysis of Complex Systems @ HU Berlin
+Copyright (c) 2022 - 2025 Modeling and Analysis of Complex Systems @ HU Berlin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,11 +1,12 @@
-# Graph Data Structure Benchmark GDSB
+# GDSB: Graph Data Structures & Benchmark
 
 <p align="center">
   <a href="https://github.com/hu-macsy/graph-ds-benchmark/actions/workflows/ci.yml"><img src="https://github.com/hu-macsy/graph-ds-benchmark/actions/workflows/ci.yml/badge.svg"></a>
 </p>
 
-This library offers various tools for graph data structure experiments including:
-- graph file I/O, see [graph_io.h](/include/gdsb/graph_io.h)
+The GDSB library offers various tools for graph data structures and experiments using benchmark functionality including:
+- standard POSIX I/O graph file I/O, see [graph_input.h](/include/gdsb/graph_input.h), [graph_output.h](/include/gdsb/graph_input.h), and [graph_io_parameters.h](/include/gdsb/graph_io_parameters.h)
+- full support to read GDSB binary graph files using MPI I/O, see [mpi_graph_io.h](/include/gdsb/mpi_graph_io.h), [mpi_error_handler.h](/include/gdsb/mpi_error_handler.h)
 - graph and edge data structures, see [graph.h](/include/gdsb/graph.h)
 - experiment environment to benchmark procedures, see
   [experiment.h](/include/gdsb/experiment.h)
@@ -17,6 +18,16 @@ This library offers various tools for graph data structure experiments including
 
 ## Releases
 
+### Version 1.0
+
+First feature complete version of GDSB, now also with full support to read and
+write graph files. As a new feature, we offer MPI graph file read functionality
+using our binary format. 
+
+| Version Number           | Tag       | URL                                                        |
+| -------------------------|-----------|------------------------------------------------------------|
+| `1.0.0`                  | `v1.0.0`  |                                                            |
+
 ### Version 0.2.0
 
 A complete revision of graph file I/O to read edges from a file reducing the