Skip to content

Commit

Permalink
used mulle-readme-cms to create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mulle-nat committed Jan 23, 2024
1 parent 7e4b311 commit 3b99ff5
Show file tree
Hide file tree
Showing 43 changed files with 343 additions and 177 deletions.
50 changes: 50 additions & 0 deletions .github/workflows/mulle-sde-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: CI

on:
push:
branches:
- release
pull_request:
workflow_dispatch:

env:
BUILD_TYPE: release

jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ macos-latest, ubuntu-latest]

steps:
- name: Set MULLE_HOSTNAME
run: |
name="${GITHUB_REF##*/}"
MULLE_HOSTNAME="${MULLE_HOSTNAME:-ci-${name##*-}}"
echo "MULLE_HOSTNAME=${MULLE_HOSTNAME}" >> $GITHUB_ENV
- name: Add to path
run: echo "$HOME/bin" >> $GITHUB_PATH

- name: Dump Environment
run: env | sort

- uses: actions/checkout@v3

- uses: mulle-sde/github-ci@v1

- name: Dump Project Environment
run: |
[ ! -d .mulle/etc/env ] || ls -l .mulle/etc/env/environment*.sh
mulle-sde environment
- name: Mulle-SDE Fetch
run: mulle-sde fetch

- name: Mulle-SDE Craft
run: mulle-sde craft --${BUILD_TYPE:-release}

- name: Mulle-SDE Test
run: |
[ ! -d test ] || mulle-sde test
31 changes: 31 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,34 @@ test/output.bin
test/demo.inc
test/demo2.inc
mulle-markdown-preview-*.html
.gitignore

# ### > generated by mulle-sde (extensions/mulle-sde/sde/init)

# .mulle/var directory is not interesting
var/

# per-user/per-host tweaks are probably not interesting in the repository

environment-user-*.sh
environment-host-*.sh
!environment-host-ci-*.sh

# stash is generally boring
stash/

# build stuff is boring too
build/
kitchen/
dependency/
addiction/
*.tmp/
tmp.*/
.mulle-make-build-dir

# test exe files are boring

test*/**/*.exe

# ### < generated by mulle-sde (extensions/mulle-sde/sde/init)

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.

27 changes: 14 additions & 13 deletions .mulle/share/env/environment.sh

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

2 changes: 2 additions & 0 deletions .mulle/share/env/motd

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: 0 additions & 2 deletions .mulle/share/match/match.d/80-header--private-headers

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

6 changes: 6 additions & 0 deletions .mulle/share/match/match.d/86-header--project-only-headers

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

1 change: 1 addition & 0 deletions .mulle/share/sde/extension

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/sde/version/mulle-sde/c

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/sde/version/mulle-sde/c-cmake

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/sde/version/mulle-sde/c-demo

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/sde/version/mulle-sde/cmake

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

1 change: 1 addition & 0 deletions .mulle/share/sde/version/mulle-sde/github-actions

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/sde/version/mulle-sde/sde

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 @@ -66,7 +66,7 @@ elseif( "${MULLE_PROJECT_TYPE}" STREQUAL "Library")
if( HEADER_PHASE)
install( FILES ${INSTALL_PUBLIC_HEADERS} DESTINATION "include/${PROJECT_NAME}")
install( FILES ${INSTALL_PRIVATE_HEADERS} DESTINATION "include/${PROJECT_NAME}")
install( FILES ${INSTALL_CMAKE_INCLUDES} DESTINATION "include/${PROJECT_NAME}/cmake")
install( FILES ${INSTALL_CMAKE_INCLUDES} DESTINATION "include/${PROJECT_NAME}/cmake")

# short cut out
if( NOT COMPILE_PHASE AND NOT LINK_PHASE)
Expand Down
23 changes: 3 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# mulle-c-string-escape

#### ➿ mulle-c-string-escape turns data into C strings
#### ➿ mulle-c-string-escape turns binary data into C strings

Non-ASCII characters will be escaped to hex or octal. C escape sequences are used
for the predefined sequences like '\b'. The output is separated into lines of approximately
Expand All @@ -27,6 +27,7 @@ static char data[] =
## Usage
```
Expand Down Expand Up @@ -118,24 +119,6 @@ diff verify.exe ./kitchen/Release/mulle-c-string-escape



## Add

Use [mulle-sde](//github.com/mulle-sde) to add mulle-c-string-escape to your project:

``` sh
mulle-sde add github:mulle-c/mulle-c-string-escape
```

To only add the sources of mulle-c-string-escape with dependency
sources use [clib](https://github.com/clibs/clib):


``` sh
clib install --out src/mulle-c mulle-c/mulle-c-string-escape
```

Add `-isystem src/mulle-c` to your `CFLAGS` and compile all the sources that were downloaded with your project.


## Install

Expand All @@ -145,7 +128,7 @@ Use [mulle-sde](//github.com/mulle-sde) to build and install mulle-c-string-esca

``` sh
mulle-sde install --prefix /usr/local \
https://github.com/mulle-c/mulle-c-string-escape/archive/latest.tar.gz
https://github.com/mulle-nat/mulle-c-string-escape/archive/latest.tar.gz
```

### Manual Installation
Expand Down
4 changes: 4 additions & 0 deletions RELEASENOTES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
### 1.1.3

* Various small improvements

### 1.1.2

* add helpful C output to stderr (squelch with -q)
Expand Down
7 changes: 7 additions & 0 deletions cmake/reflect/_Headers.cmake

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

Loading

0 comments on commit 3b99ff5

Please sign in to comment.