Experiment simpler website paths without about subdir and renames, simplify readme

Author: Tremeschin

.gitignore

@@ -1,4 +1,2 @@
 .cache
-*.pyc
 site
-website/index.md

readme.md

@@ -1,31 +1,17 @@
 <div align="center">
-  <img src="https://raw.githubusercontent.com/BrokenSource/ShaderFlow/main/website/assets/logo.png" width="210">
+  <img src="https://raw.githubusercontent.com/BrokenSource/ShaderFlow/main/website/assets/logo.png" width="180">
   <h1>ShaderFlow</h1>
   <span>Modular shader engine designed for simplicity and speed</span>
   <br>
   <br>
   <a href="https://pypi.org/project/shaderflow/"><img src="https://img.shields.io/pypi/v/shaderflow?label=PyPI&color=blue"></a>
   <a href="https://pypi.org/project/shaderflow/"><img src="https://img.shields.io/pypi/dw/shaderflow?label=%E2%86%93&color=blue"></a>
-  <a href="https://github.com/BrokenSource/ShaderFlow/releases/"><img src="https://img.shields.io/github/v/release/BrokenSource/ShaderFlow?label=Pyaket&color=light-green"></a>
-  <a href="https://github.com/BrokenSource/ShaderFlow/releases/"><img src="https://img.shields.io/github/downloads/BrokenSource/ShaderFlow/total?label=%E2%86%93&color=light-green"></a>
   <a href="https://github.com/BrokenSource/ShaderFlow/stargazers"><img src="https://img.shields.io/github/stars/BrokenSource/ShaderFlow?label=Stars&style=flat&color=orange"></a>
   <a href="https://discord.gg/KjqvcYwRHm"><img src="https://img.shields.io/discord/1184696441298485370?label=Discord&style=flat&color=purple"></a>
   <br>
-  <b>
-    Links •
-    <a href="https://github.com/BrokenSource/ShaderFlow/">GitHub</a> •
-    <a href="https://shaders.tremeschin.com/">Documentation</a> •
-    <a href="https://github.com/sponsors/Tremeschin/">Support</a> •
-    <a href="https://shaders.tremeschin.com/about/license/">License</a>
-  </b>
-  <br>
   <sub><small>⭐️ Consider starring the project to help it grow! ⭐️</small></sub>
-  <br>
-  <br>
 </div>
 
-<video src="https://github.com/user-attachments/assets/100939e1-b246-4b5a-a46d-99cda4a901b7" controls></video>
-
 ## 🔥 Description
 
 **ShaderFlow** is a platform for creating and exporting GLSL shaders scenes to videos or realtime previews, with a modularity similar to manim and shadertoy's simplicity.
@@ -35,7 +21,10 @@
 - [x] **Camera** module using quaternions, generic for Ray Marching, 2D, VR scenes
 - [x] **Audio** reactive processing for music visualizers, FFTs already in natural scale
 - [x] **Commercial** use allowed and encouraged, simply pick a [❤️ Sponsorship](https://github.com/sponsors/Tremeschin/) tier!
-- [x] No watermarks, unlimited usage, portable executables made with [📦 Pyaket](https://pyaket.tremeschin.com/)
+
+Example music visualizer scene:
+
+<video src="https://github.com/user-attachments/assets/100939e1-b246-4b5a-a46d-99cda4a901b7" controls></video>
 
 ## 📦 Getting Started
 

website/about/examples.md

@@ -7,8 +7,6 @@ icon: material/docker
 
 ShaderFlow provides prebuilt images at [ghcr.io/brokensource/shaderflow](https://ghcr.io/brokensource/shaderflow) with working OpenGL support for rendering scenes in reproducible environments - ideal for expensive or long pipelines in the cloud, mass exporting videos, or general automation.
 
-:warning: **Make sure** to follow the project's [licensing](../about/license.md) on commercial use!
-
 <small><b>Note:</b> Dockerfiles are made in [BrokenSource/Containers](https://github.com/BrokenSource/Containers)</small>
 
 ## Runtime

website/about/changelog.md website/changelog.mdwebsite/about/changelog.md renamed to website/changelog.md

@@ -2,6 +2,15 @@
 title: Showcase
 ---
 
+After activating the Virtual Environment on `.venv`:
+
+- Run `shaderflow` to see all available scenes
+- Run `shaderflow (scene)` to see commands of a scene
+- Run `shaderflow (scene) main` to run a specific scene
+- Run `shaderflow (scene) main --help` for scene options
+
+Go for the Python file listed in the output for examples!
+
 [Example Scripts](https://github.com/BrokenSource/ShaderFlow/tree/main/examples){.md-button .md-button--primary}
 
 Also check out [⭐️ Pianola](https://github.com/BrokenSource/Pianola) and [⭐️ DepthFlow](https://github.com/BrokenSource/DepthFlow) projects!

website/get/docker.md

@@ -11,27 +11,27 @@ nav = [
   {Origin = "https://tremeschin.com/"},
   {Home = [
     "index.md",
-    "about/changelog.md",
-    "about/license.md",
+    "changelog.md",
+    "license.md",
   ]},
-  {Installation = [
+  {Get = [
     "get/pypi.md",
     # "get/pyaket.md",
     "get/source.md",
     "get/docker.md",
   ]},
-  {Examples = [
+  {Show = [
     "show/index.md",
   ]},
-  {Documentation = [
+  {Docs = [
     "docs/index.md",
     "docs/module.md",
     "docs/scene.md",
     "docs/camera.md",
     "docs/shader.md",
     "docs/texture.md",
   ]},
-  {Questions = [
+  {FAQ = [
     "faq/index.md",
     {Base = [
       "faq/general.md",