From 0b5031cfcc96d6b6f2c06dbf40c7bd0a66723e08 Mon Sep 17 00:00:00 2001 From: Nat! Date: Mon, 22 Jan 2024 15:13:48 +0100 Subject: [PATCH] fix README.md --- .mulle/share/env/environment-plugin.sh | 2 +- .mulle/share/env/version | 2 +- CMakeLists.txt | 2 +- README.md | 51 +++----------------------- RELEASENOTES.md | 4 ++ cola/config.plist | 6 +++ cola/description.md.bud | 6 +-- cola/install.md.bud | 7 ++++ overview.dot | 11 ++++++ overview.dot.svg | 36 +++++++++++++++--- 10 files changed, 68 insertions(+), 59 deletions(-) create mode 100644 cola/config.plist create mode 100644 cola/install.md.bud create mode 100644 overview.dot diff --git a/.mulle/share/env/environment-plugin.sh b/.mulle/share/env/environment-plugin.sh index 7fea9b3..89a692f 100644 --- a/.mulle/share/env/environment-plugin.sh +++ b/.mulle/share/env/environment-plugin.sh @@ -22,6 +22,6 @@ export MULLE_SOURCETREE_SYMLINK='YES' # # # -export MULLE_SDE_INSTALLED_VERSION="2.3.0" +export MULLE_SDE_INSTALLED_VERSION="3.0.0" diff --git a/.mulle/share/env/version b/.mulle/share/env/version index 831446c..91ff572 100644 --- a/.mulle/share/env/version +++ b/.mulle/share/env/version @@ -1 +1 @@ -5.1.0 +5.2.0 diff --git a/CMakeLists.txt b/CMakeLists.txt index f14962b..4a9227c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -2,7 +2,7 @@ cmake_minimum_required( VERSION 3.14) project( mulle-objc-developer NONE) -set( PROJECT_VERSION 0.26.0) +set( PROJECT_VERSION 0.26.1) if( APPLE) diff --git a/README.md b/README.md index 780f67b..2401dd2 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ #### 🎩 mulle-objc developer kit for mulle-sde -This is a collection of [mulle-sde](//github.com/mulle-sde/mulle-sde) +This is a collection of [mulle-sde](//github.com/mulle-sde) *extensions* to support development of [MulleObjC](//github.com/mulle-objc) code. As a package **mulle-objc-developer** is also a convenient way to install mulle-sde and [mulle-clang](//github.com/Codeon-GmbH/mulle-clang). @@ -10,10 +10,6 @@ install mulle-sde and [mulle-clang](//github.com/Codeon-GmbH/mulle-clang). -| Release Version | Release Notes -|-------------------------------------------------------|-------------- -| ![Mulle kybernetiK tag](https://img.shields.io/github/tag/mulle-objc/mulle-objc-developer.svg?branch=release) [![Build Status](https://github.com/mulle-objc/mulle-objc-developer/workflows/CI/badge.svg?branch=release)](//github.com/mulle-objc/mulle-objc-developer/actions) | [RELEASENOTES](RELEASENOTES.md) | - @@ -27,51 +23,14 @@ install mulle-sde and [mulle-clang](//github.com/Codeon-GmbH/mulle-clang). -## Add - -### Add as an individual component - -Use [mulle-sde](//github.com/mulle-sde) to add mulle-objc-developer to your project: - -``` sh -mulle-sde add github:mulle-objc/mulle-objc-developer -``` - -To only add the sources of mulle-objc-developer with dependency -sources use [clib](https://github.com/clibs/clib): - - -``` sh -clib install --out src/mulle-objc mulle-objc/mulle-objc-developer -``` - -Add `-isystem src/mulle-objc` to your `CFLAGS` and compile all the sources that were downloaded with your project. - ## Install -### Install with mulle-sde - -Use [mulle-sde](//github.com/mulle-sde) to build and install mulle-objc-developer: - -``` sh -mulle-sde install --prefix /usr/local \ - https://github.com/mulle-objc/mulle-objc-developer/archive/latest.tar.gz -``` - -### Manual Installation - -Install the [Requirements](#Requirements) and then -install **mulle-objc-developer** with [cmake](https://cmake.org): +Install [foundation-developer](//github.com/MulleFoundation/foundation-developer) and +mulle-objc-developer will part of the deal. -``` sh -cmake -B build \ - -DCMAKE_INSTALL_PREFIX=/usr/local \ - -DCMAKE_PREFIX_PATH=/usr/local \ - -DCMAKE_BUILD_TYPE=Release && -cmake --build build --config Release && -cmake --install build --config Release -``` +> If you really want just mulle-objc-developer, +> examine the "Script" approach and reduce the `OTHER_PROJECTS`. ## Author diff --git a/RELEASENOTES.md b/RELEASENOTES.md index 9592f1c..b604abc 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -1,3 +1,7 @@ +### 0.26.1 + +* Various small improvements + ## 0.26.0 * update version numbers to use unsigned long diff --git a/cola/config.plist b/cola/config.plist new file mode 100644 index 0000000..d8f5fa2 --- /dev/null +++ b/cola/config.plist @@ -0,0 +1,6 @@ +{ + config = + { + skipAdd = YES; + }; +} diff --git a/cola/description.md.bud b/cola/description.md.bud index f1e09a4..7d8fe91 100644 --- a/cola/description.md.bud +++ b/cola/description.md.bud @@ -1,5 +1,3 @@ -This is a collection of [mulle-sde](//github.com/mulle-sde/mulle-sde) +This is a collection of [mulle-sde](//github.com/mulle-sde) *extensions* to support development of [MulleObjC](//github.com/mulle-objc) -code. As a package **mulle-objc-developer** is also a convenient way to -install mulle-sde and [mulle-clang](//github.com/Codeon-GmbH/mulle-clang). - +code. diff --git a/cola/install.md.bud b/cola/install.md.bud new file mode 100644 index 0000000..3833db4 --- /dev/null +++ b/cola/install.md.bud @@ -0,0 +1,7 @@ +## Install + +Install [foundation-developer](//github.com/MulleFoundation/foundation-developer) and +{{ project.name }} will part of the deal. + +> If you really want just {{ project.name }}, +> examine the "Script" approach and reduce the `OTHER_PROJECTS`. diff --git a/overview.dot b/overview.dot new file mode 100644 index 0000000..40289e0 --- /dev/null +++ b/overview.dot @@ -0,0 +1,11 @@ +digraph sourcetree +{ + rankdir = TD; + node [ shape="box"; style="filled" ] + "mulle-objc-developer" [ fillcolor="yellow"] + // not inheriting from mulle-objc-developer + "mulle-c-developer" [ fillcolor="white"] + "mulle-sde-developer" [ fillcolor="white"] + + "mulle-objc-developer" -> "mulle-c-developer" -> "mulle-sde-developer" +} diff --git a/overview.dot.svg b/overview.dot.svg index ec99944..b9cad46 100644 --- a/overview.dot.svg +++ b/overview.dot.svg @@ -4,16 +4,40 @@ - - + + sourcetree - + mulle-objc-developer - -mulle-objc-developer + +mulle-objc-developer + + + +mulle-c-developer + +mulle-c-developer + + + +mulle-objc-developer->mulle-c-developer + + + + + +mulle-sde-developer + +mulle-sde-developer + + + +mulle-c-developer->mulle-sde-developer + +