Update all READMEs.
This commit is contained in:
parent
bb6fc237e8
commit
0585110df4
19
README.md
Normal file
19
README.md
Normal file
@ -0,0 +1,19 @@
|
||||
[LibIPC][libipc] examples in many languages:
|
||||
- C
|
||||
- Zig
|
||||
- Crystal
|
||||
|
||||
and soon even more!
|
||||
|
||||
# Build
|
||||
|
||||
Just type `make` in the right directory.
|
||||
|
||||
# Some makefile utilities
|
||||
|
||||
All examples' makefiles include `mk/makefile.utils`.
|
||||
Go have a look.
|
||||
You'll be able to ask for a static build, run an application with valgrind with many options, and so on.
|
||||
For example: `make STATIC=1 build` will compile your example as a static executable (in all languages).
|
||||
|
||||
[libipc]: https://git.baguette.netlib.re/Baguette/libipc
|
25
c/README.md
25
c/README.md
@ -1,6 +1,25 @@
|
||||
Some C examples, nothing fancy.
|
||||
Implementation is straightforward.
|
||||
[LibIPC][libipc] C examples: `pong` and `pongd` (simple service and its client, just echoing received messages).
|
||||
Implementations are straightforward.
|
||||
|
||||
# Build
|
||||
## Build
|
||||
|
||||
`make`
|
||||
|
||||
Some options are available, such as static builds.
|
||||
|
||||
```sh
|
||||
make STATIC=1 # Build static executables.
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```sh
|
||||
./zig-out/bin/pongd # run the service
|
||||
./zig-out/bin/pong # run the client
|
||||
```
|
||||
|
||||
## LICENSE
|
||||
|
||||
ISC
|
||||
|
||||
[libipc]: https://git.baguette.netlib.re/Baguette/libipc
|
||||
|
@ -1,12 +1,10 @@
|
||||
# LibIPC examples
|
||||
|
||||
Crystal LibIPC examples, using [libipc bindings shard][bindings].
|
||||
|
||||
## Installation
|
||||
## Build
|
||||
|
||||
```sh
|
||||
# Compiles all examples.
|
||||
shards build
|
||||
make
|
||||
```
|
||||
|
||||
Currently there are 2 examples:
|
||||
@ -21,7 +19,7 @@ Currently there are 2 examples:
|
||||
./bin/pong # run the client
|
||||
```
|
||||
|
||||
# LICENCE
|
||||
## LICENSE
|
||||
|
||||
ISC
|
||||
|
||||
|
34
zig/README.md
Normal file
34
zig/README.md
Normal file
@ -0,0 +1,34 @@
|
||||
Zig [LibIPC][libipc] examples:
|
||||
`pong` and `pongd` (as you find in all other examples).
|
||||
`tcpd` and `ipcd`, to make any LibIPC application network-ready.
|
||||
Documentation will come soon for these.
|
||||
|
||||
## Build
|
||||
|
||||
```sh
|
||||
# Compiles all examples.
|
||||
make
|
||||
```
|
||||
|
||||
Several options are available.
|
||||
|
||||
```sh
|
||||
# Compiles all examples.
|
||||
make STATIC=1 # Build static executables.
|
||||
make ZIG_OPTIM=ReleaseSmall # Build small executables.
|
||||
```
|
||||
|
||||
Read the makefile.
|
||||
|
||||
## Usage
|
||||
|
||||
```sh
|
||||
./zig-out/bin/pongd # run the service
|
||||
./zig-out/bin/pong # run the client
|
||||
```
|
||||
|
||||
## LICENSE
|
||||
|
||||
ISC
|
||||
|
||||
[libipc]: https://git.baguette.netlib.re/Baguette/libipc
|
Loading…
Reference in New Issue
Block a user