Skip to content

Commit

Permalink
fix README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mulle-nat committed Jan 22, 2024
1 parent e150feb commit 0b5031c
Show file tree
Hide file tree
Showing 10 changed files with 68 additions and 59 deletions.
2 changes: 1 addition & 1 deletion .mulle/share/env/environment-plugin.sh

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .mulle/share/env/version

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
51 changes: 5 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,14 @@

#### 🎩 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).




| 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) |




Expand All @@ -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
Expand Down
4 changes: 4 additions & 0 deletions RELEASENOTES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
### 0.26.1

* Various small improvements

## 0.26.0

* update version numbers to use unsigned long
Expand Down
6 changes: 6 additions & 0 deletions cola/config.plist
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
config =
{
skipAdd = YES;
};
}
6 changes: 2 additions & 4 deletions cola/description.md.bud
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions cola/install.md.bud
Original file line number Diff line number Diff line change
@@ -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`.
11 changes: 11 additions & 0 deletions overview.dot
Original file line number Diff line number Diff line change
@@ -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"
}
36 changes: 30 additions & 6 deletions overview.dot.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0b5031c

Please sign in to comment.