Update readmes, fix tpyo

Author: doZennn

CONTRIBUTING.md

@@ -1,12 +1,14 @@
-# Project conventions
+# Project conventions and tips
 
 1. Use [ShellCheck](https://www.shellcheck.net/)
-2. Indent with 4 spaces.
-3. Variables:
+2. You need to use this fork of innoextract: https://github.com/doZennn/innoextract
+3. You don't need to build anything. Work on `src.sh` directly, it will load `innoextract` from the cwd.
+4. Indent with 4 spaces.
+5. Variables:
     - Global: `ALL_CAPS` - mostly static values used everywhere
     - Local: `_underscore_prefix_and_lowercase` - only be used within a scope
-4. Always use `printf` instead of `echo`.
-5. Use LOTS of comments! Scripts are already hard to read especially when it's a bunch of pipes chained together, comments save time trying to figure out what something does.
-6. Everything must be as POSIX compliant as you can get it. It's okay to deviate from this within reason.
-7. Stick to using tools commonly installed by default on most distros, use fallbacks where appropriate.
-8. Final script must be functional when piped into `sh` (e.g. `cat zoom-platform.sh | sh`). An example of something you can't do is using `"$0"` to get the script name.
+6. Always use `printf` instead of `echo`.
+7. Use LOTS of comments! Scripts are already hard to read especially when it's a bunch of pipes chained together, comments save time trying to figure out what something does.
+8. Everything must be as POSIX compliant as you can get it. It's okay to deviate from this within reason.
+9. Stick to using tools commonly installed by default on most distros, use fallbacks where appropriate.
+10. Final script must be functional when piped into `sh` (e.g. `cat zoom-platform.sh | sh`). An example of something you can't do is using `"$0"` to get the script name.

README.md

@@ -1,2 +1,29 @@
-# zoom-platform.sh
+# [zoom-platform.sh](https://zoom-platform.sh/)
+A tool to streamline installation, updating, and playing Windows games from [ZOOM Platform](https://www.zoom-platform.com/) on Linux using [umu](https://github.com/Open-Wine-Components/umu-launcher) and Proton.
 
+## Building
+| Script | Example | - |
+| - | - | - |
+| **build.sh** | `./build.sh "src.sh" "innoextract-upx" > output.sh` | Takes an input `src.sh`, embeds an innoextract binary, sets the version, prepends licences then prints the output. |
+| **dist.sh**  |  | Downloads innoextract then creates a `zoom-platform.sh` file using `build.sh` |
+
+## Website
+The website is just a static `index.html` in [www/public](www/public).  
+A small web server is used so users can get the script at the latest commit or a specific hash.
+See the [README](www/README.md) here.
+
+## Usage
+For the script help, see `-h`.  
+For the website:
+| URL (either http or https works) |  |
+| - | - |
+| `curl zoom-platform.sh` | Returns the latest stable version of the script. |
+| `curl zoom-platform.sh/latest` | Returns the script built from the latest commit. |
+| `curl zoom-platform.sh/b8dbaf9` | Returns the script built from a specific commit. |
+| `curl zoom-platform.sh/b8dbaf9cde1f98c09d7da6874c3931014275fd4b` | Same as above but using the full hash. |
+
+## Contributing
+Please see [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## Licence
+[BSD-3](LICENSE)

www/README.md

@@ -3,10 +3,9 @@ Deno server only required if you want to be able to serve specific versions of t
 
 ## Deploying
 1. Clone this repo
-2. `./dist.sh`
-3. `./start-www.sh` (saves latest stable script to www/dist)
-4. `deno task start` (optional)
-5. Serve `www/dist`
+2. `./start-www.sh` (saves latest stable script to www/public)
+3. `deno task start` (optional)
+4. Serve `www/public`
 
 We can't use GitHub/CF Pages cause they force SSL. Server is running Nginx with a simple config:
 ```nginx

www/public/index.html

@@ -344,7 +344,7 @@
     </div>
     <main>
       <section id="description">
-        <p><i class="color-primary">zoom-platform.sh</i> is an helpful tool to streamline installation, updating, and
+        <p><i class="color-primary">zoom-platform.sh</i> is a helpful tool to streamline installation, updating, and
           playing Windows games from <a href="https://www.zoom-platform.com/">ZOOM Platform</a> on Linux using <a
             href="https://github.com/Open-Wine-Components/umu-launcher">umu</a> and
           Proton.</p>