From 025f9e7a39a321c44bd017089f43a559bd2022a8 Mon Sep 17 00:00:00 2001 From: Jordan Eldredge Date: Tue, 7 May 2024 21:05:45 -0700 Subject: [PATCH] Improve docs and fix bug with specifying window size when not using Milkdrop --- examples/minimalMilkdrop/index.html | 5 +- examples/minimalWindowLayout/README.md | 11 ++ examples/minimalWindowLayout/index.html | 40 ++++++ examples/readme.md | 1 + examples/webpackLazyLoad/index.js | 6 +- packages/webamp/CHANGELOG.md | 9 +- packages/webamp/demo/js/webampConfig.ts | 22 ++- packages/webamp/docs/usage.md | 178 +++++++++++++++--------- packages/webamp/js/reducers/windows.ts | 18 ++- packages/webamp/js/types.ts | 9 ++ 10 files changed, 219 insertions(+), 80 deletions(-) create mode 100644 examples/minimalWindowLayout/README.md create mode 100755 examples/minimalWindowLayout/index.html diff --git a/examples/minimalMilkdrop/index.html b/examples/minimalMilkdrop/index.html index 84566dcc88..b9b31966c1 100755 --- a/examples/minimalMilkdrop/index.html +++ b/examples/minimalMilkdrop/index.html @@ -13,7 +13,7 @@ diff --git a/examples/minimalWindowLayout/README.md b/examples/minimalWindowLayout/README.md new file mode 100644 index 0000000000..a5cec38c47 --- /dev/null +++ b/examples/minimalWindowLayout/README.md @@ -0,0 +1,11 @@ +# Minimal Example Window Layout + +This example demonstrates configuring the initial layout of windows in Webamp. + +You should be able to open this local html file in your browser and see Webamp working. + +``` +$ git clone git@github.com:captbaritone/webamp.git +$ cd webamp +$ open examples/minimalWindowLayout/index.html +``` diff --git a/examples/minimalWindowLayout/index.html b/examples/minimalWindowLayout/index.html new file mode 100755 index 0000000000..cb6691b631 --- /dev/null +++ b/examples/minimalWindowLayout/index.html @@ -0,0 +1,40 @@ + + + + + + + +
+ +
+ + + + diff --git a/examples/readme.md b/examples/readme.md index 0d8cde6f76..53457bbddd 100644 --- a/examples/readme.md +++ b/examples/readme.md @@ -5,6 +5,7 @@ This directory contains a number of examples of how to add Webamp to a project. - [Minimal](./minimal) Stick Webamp in a `