README updated, and PNG, SVG images removed from the repo

Signed-off-by: Davide Scano <[email protected]>
p4lang · Dec 7, 2024 · 6a58e48 · 6a58e48
1 parent 9eae1e4
commit 6a58e48
Show file tree

Hide file tree

Showing 17 changed files with 13 additions and 19,239 deletions.
diff --git a/docs/v1/README.md b/docs/v1/README.md
@@ -28,6 +28,12 @@ Files:
 
 ## Document Figures
 
+The P4Runtime specification can be generated on your local machine or via the Docker container. Due to this, the document figure can be rendered using two different approaches
+
+### Local machine
+
+You need to install [LibreOffice](https://nl.libreoffice.org/) on your local machine.
+
 Each image in the specification has a corresponding `.odg` file under
 `resources/figs/`. These are LibreOffice drawing files. The files are rendered into
 `.svg` and `.png` images (for HTML and PDF output, resepectively) at build time,
@@ -51,6 +57,11 @@ Commands to convert a image `.odg` to `.svg` and/or `.png` and  move to `resourc
 soffice --convert-to svg  --outdir resources/figs/  figure_name.odg 
 soffice --convert-to png  --outdir resources/figs/  figure_name.odg 
 ```
+### Docker container
+
+The Docker container, generated from the `p4lang/p4rt-asciidoc:latest` image, does not require 
+LibreOffice to be installed.
+
 
 ## Building
 
@@ -61,8 +72,8 @@ The easiest way to render the AsciiDoc specification documentation is to use the
 
 ### Linux
 ```
-You can use the [local installation](https://github.com/p4lang/p4-spec/blob/main/p4-16/spec/install-asciidoctor-linux.sh)
-method.
+You can use the [local installation](https://github.com/p4lang/p4-spec/blob/main/p4-16/spec/install-asciidoctor-linux.sh) method, and you also need to install LibreOffice to render the 
+images into .svg and .png formats.
 
 ### MacOS
 

diff --git a/docs/v1/resources/figs/embedded-plus-single-remote-controller.png b/docs/v1/resources/figs/embedded-plus-single-remote-controller.png
diff --git a/docs/v1/resources/figs/embedded-plus-single-remote-controller.svg b/docs/v1/resources/figs/embedded-plus-single-remote-controller.svg
diff --git a/docs/v1/resources/figs/embedded-plus-two-remote-controllers.png b/docs/v1/resources/figs/embedded-plus-two-remote-controllers.png
diff --git a/docs/v1/resources/figs/embedded-plus-two-remote-controllers.svg b/docs/v1/resources/figs/embedded-plus-two-remote-controllers.svg
diff --git a/docs/v1/resources/figs/embedded-plus-two-remote-ha-controllers.png b/docs/v1/resources/figs/embedded-plus-two-remote-ha-controllers.png
diff --git a/docs/v1/resources/figs/embedded-plus-two-remote-ha-controllers.svg b/docs/v1/resources/figs/embedded-plus-two-remote-ha-controllers.svg
diff --git a/docs/v1/resources/figs/error-report.png b/docs/v1/resources/figs/error-report.png
diff --git a/docs/v1/resources/figs/error-report.svg b/docs/v1/resources/figs/error-report.svg
diff --git a/docs/v1/resources/figs/psa-metadata-translation.png b/docs/v1/resources/figs/psa-metadata-translation.png
diff --git a/docs/v1/resources/figs/psa-metadata-translation.svg b/docs/v1/resources/figs/psa-metadata-translation.svg
diff --git a/docs/v1/resources/figs/reference-architecture.png b/docs/v1/resources/figs/reference-architecture.png
diff --git a/docs/v1/resources/figs/reference-architecture.svg b/docs/v1/resources/figs/reference-architecture.svg
diff --git a/docs/v1/resources/figs/single-embedded-controller.png b/docs/v1/resources/figs/single-embedded-controller.png
diff --git a/docs/v1/resources/figs/single-embedded-controller.svg b/docs/v1/resources/figs/single-embedded-controller.svg
diff --git a/docs/v1/resources/figs/single-remote-controller.png b/docs/v1/resources/figs/single-remote-controller.png
diff --git a/docs/v1/resources/figs/single-remote-controller.svg b/docs/v1/resources/figs/single-remote-controller.svg