Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Moe-hacker committed Nov 21, 2024
1 parent 61fa27e commit 6b00bf3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ Ruri provides statically linked binary, but if you want to build it yourself, se
# Integration:
ruri is ready to integrate into other projects, with the MIT License, it is compatiblte to be redistribute with almost all license, or commercial/closed source.
An example is ruri's own build action [build-all.sh](build/build-all.sh), it runs containers for 9 different architectures to build itself, that shows its broad application prospects.
Another example is [rurima](https://github.com/Moe-hacker/rurima), I made ruri built-in into it, so it can be run as a subcommand.
See [Integration](doc/Integration.md) for a guide to integrate ruri into your projects.
# Usage:
See [USAGE](doc/USAGE.md)
Expand Down
4 changes: 3 additions & 1 deletion doc/Integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,6 @@ Use `ruri -D -o test.conf /test` to dump the config into test.conf
You can also add other options like `ruri -D -o test.conf -d cap_chmod -k cap_sys_admin -w -u /test /bin/sh`
So next time, just use `ruri -c /path/to/test.conf` to run the container.
## integrate with source:
If your project supports, you can also edit the main.c, remove `main()` function and use ruri as a lib. But make sure that you know how main.c works, especially how CONTAINER struct works.
main() has been replaced to ruri, and every funcion in ruri have ruri_ or nekofeng_ prefix now, so you need not worry about conflicts of symbols now.
If your project supports, you can remove `main()` function and use ruri as a lib. But make sure that you know how ruri.c works, especially how RURI_CONTAINER struct works.
An example is [rurima](https://github.com/Moe-hacker/rurima), I made ruri to be its subcommand. So `rurima r` have the same effect with `ruri`.

0 comments on commit 6b00bf3

Please sign in to comment.