From 14c4c0253c51506caddb380c65fd56e0cf1060ab Mon Sep 17 00:00:00 2001 From: Stefano Brivio Date: Fri, 4 Mar 2022 16:34:52 +0100 Subject: README: Make it somewhat readable on mobile devices Signed-off-by: Stefano Brivio --- README.md | 119 ++++++++++++++++++++++++++++++++++++--------------- doc/ci.html | 19 ++++++++ doc/demo_passt.html | 19 ++++++++ doc/demo_pasta.html | 19 ++++++++ doc/demo_podman.html | 19 ++++++++ hooks/pre-push | 1 + 6 files changed, 161 insertions(+), 35 deletions(-) create mode 100644 doc/ci.html create mode 100644 doc/demo_passt.html create mode 100644 doc/demo_pasta.html create mode 100644 doc/demo_podman.html diff --git a/README.md b/README.md index 45f9e51..cd4caa3 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,45 @@ Author: Stefano Brivio While functional and tested to some extent, this project is still in early development phase: don't use in production or critical environments yet. + + # passt: Plug A Simple Socket Transport _passt_ implements a translation layer between a Layer-2 network interface and @@ -13,12 +52,13 @@ native Layer-4 sockets (TCP, UDP, ICMP/ICMPv6 echo) on a host. It doesn't require any capabilities or privileges, and it can be used as a simple replacement for Slirp. +
Overview diagram of passt - + @@ -50,6 +90,7 @@ replacement for Slirp. +
- -
+
+ ### passt -
+
+ ## Continuous Integration -
+
-
+
+ Test logs [here](/builds/latest/test/). diff --git a/doc/ci.html b/doc/ci.html new file mode 100644 index 0000000..46a6e48 --- /dev/null +++ b/doc/ci.html @@ -0,0 +1,19 @@ + + + + +Continuous integration test run + + + + +
+ + + diff --git a/doc/demo_passt.html b/doc/demo_passt.html new file mode 100644 index 0000000..1cef904 --- /dev/null +++ b/doc/demo_passt.html @@ -0,0 +1,19 @@ + + + + +demo: Overview of passt functionality + + + + +
+ + + diff --git a/doc/demo_pasta.html b/doc/demo_pasta.html new file mode 100644 index 0000000..dc4101b --- /dev/null +++ b/doc/demo_pasta.html @@ -0,0 +1,19 @@ + + + + +demo: Overview of pasta functionality + + + + +
+ + + diff --git a/doc/demo_podman.html b/doc/demo_podman.html new file mode 100644 index 0000000..33cd9e8 --- /dev/null +++ b/doc/demo_podman.html @@ -0,0 +1,19 @@ + + + + +demo: Overview of Podman operation with pasta + + + + +
+ + + diff --git a/hooks/pre-push b/hooks/pre-push index 73dac94..678ca29 100755 --- a/hooks/pre-push +++ b/hooks/pre-push @@ -62,6 +62,7 @@ for pic in passt_overview pasta_overview; do cwebp -preset drawing -q 10 "doc/${pic}.png" -o "doc/${pic}.webp" scp "doc/${pic}.png" "doc/${pic}.png" "${USER_HOST}:${WEB}/" done +scp doc/*.html "${USER_HOST}:${WEB}/" ssh "${USER_HOST}" "mv ${LATEST} ${AWAY}" ssh "${USER_HOST}" "mv ${TEMP} ${LATEST}" -- cgit v1.2.3