Skip to content

Commit

Permalink
feat: add a small script to view HTML from remote
Browse files Browse the repository at this point in the history
  • Loading branch information
shioyadan committed Nov 25, 2024
1 parent 8f811ca commit 128114d
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions src/launch_httpd.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
echo http://localhost:30080/
python3 -m http.server 30080

0 comments on commit 128114d

Please sign in to comment.