From 128114d89fc696c06c9279d2abcc433de8547b5c Mon Sep 17 00:00:00 2001 From: Ryota Shioya Date: Mon, 25 Nov 2024 15:33:43 +0900 Subject: [PATCH] feat: add a small script to view HTML from remote --- Makefile | 1 + README.md | 7 +++++-- src/launch_httpd.sh | 2 ++ 3 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 src/launch_httpd.sh diff --git a/Makefile b/Makefile index 19e5f73..6873785 100644 --- a/Makefile +++ b/Makefile @@ -6,6 +6,7 @@ production: mkdir -p dist npx webpack --mode production cp src/embed.sh dist/embed.sh + cp src/launch_httpd.sh dist/launch_httpd.sh cp ./THIRD-PARTY-LICENSES.md dist/THIRD-PARTY-LICENSES.md serve: diff --git a/README.md b/README.md index bca8e73..1322b95 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,16 @@ Currently, Meno supports hierarchical area reports from Vivado, Genus, and DC. * Drag and drop an input file onto `index.html` to visualize it. * You can create an HTML file with your input file embedded by passing the input file to `embed.sh`: ```bash + # Generate an HTML file (your_area_report.txt.html) in the same directory. ./embed.sh your_area_report.txt - # Generate your_area_report.txt.html at the same directory + + # Launch an WEB server, which is useful to view the output HTML from a remote client. + ./launch_httpd.sh ``` ## Development -This project is designed for development using Node.js (version 18). If you encounter compatibility issues, it is recommended to use the following Docker environment. +This project is designed for development using Node.js (version 18) on Ubuntu 24.04. If you encounter compatibility issues, it is recommended to use the following Docker environment, which is based on an Ubuntu 24.04 image. ```bash # Initialize Node modules diff --git a/src/launch_httpd.sh b/src/launch_httpd.sh new file mode 100644 index 0000000..441c1cd --- /dev/null +++ b/src/launch_httpd.sh @@ -0,0 +1,2 @@ +echo http://localhost:30080/ +python3 -m http.server 30080