Skip to content

Commit 738e273

Browse files
committed
Simplify use zentheme for common css, features, palette, sketch codecs liability section
1 parent 1049a5d commit 738e273

9 files changed

Lines changed: 48 additions & 73 deletions

File tree

.github/workflows/website.yml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,6 @@ jobs:
1616
environment:
1717
name: github-pages
1818
steps:
19-
- uses: actions/checkout@v6
20-
- uses: astral-sh/setup-uv@v7
21-
- run: ln readme.md website/index.md
22-
- run: uvx zensical build
23-
- run: mv site _site
19+
- uses: BrokenSource/Zentheme@main
2420
- uses: actions/upload-pages-artifact@v4
2521
- uses: actions/deploy-pages@v4
26-

website/about/license.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,30 @@
22
title: License
33
icon: material/license
44
---
5+
6+
!!! warning "Work in progress"
7+
8+
## Code
9+
10+
ShaderFlow is licensed under the AGPLv3, a strong copyleft license to ensure it remains Free and Open Source for all users.
11+
12+
## Liability
13+
14+
### Content
15+
16+
User Generated Content (...)
17+
18+
### Codecs
19+
20+
Certain FFmpeg codecs may be covered by patents in some jurisdictions. Chances are you'll never get into trouble by sharing private or public facing videos, but selling may require attention.
21+
22+
ShaderFlow defaults to the following options and their reasoning:
23+
24+
- **Video**: Uses H.264 (mostly expired patents)[^h264] for performance and compatibility. Other royalty-free options such as AV1 may take its place in the future to move the ecosystem forward.
25+
- **Audio**: Copies the original file into the video for best quality, avoiding a re-encode.
26+
27+
[^h264]: Wikimedia: [Have the patents for H.264 MPEG-4 AVC expired yet?](https://meta.wikimedia.org/wiki/Have_the_patents_for_H.264_MPEG-4_AVC_expired_yet%3F)
28+
29+
Other options are available in the wrappers, note it includes 'non-free' ones for completeness and research purposes. Users must ensure compliance and follow external terms when applicable.
30+
31+
<small><b>Read more:</b> https://ffmpeg.org/legal.html</small>

website/assets/main.css

Lines changed: 0 additions & 15 deletions
This file was deleted.

website/faq/general.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: General
33
icon: octicons/package-16
44
---
55

6-
-> **Note**: For executables see [Pyaket's FAQ](https://pyaket.tremeschin.com/faq/general/)
7-
86
## **Q:** Crashes on exporting videos {#export-crashes}
97

108
-> Using `scene main --no-turbo (...)` or `scene.main(turbo=False)` might fix it.

website/faq/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Questions
3+
---
4+
5+
Chose a topic below or in the navigation bar:
6+
7+
- **Systems**: [**Windows**](./windows.md), [**Linux**](./linux.md), [**macOS**](./macos.md)
8+
- **Base**: [**General**](./general.md)
9+

website/faq/linux.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,4 @@ title: Linux
33
icon: simple/linux
44
---
55

6-
-> **Note**: For executables see [Pyaket's FAQ](https://pyaket.tremeschin.com/faq/linux/)
7-
86
> No known frequently asked questions at the moment.

website/faq/macos.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@ title: macOS
33
icon: simple/apple
44
---
55

6-
-> **Note**: For executables see [Pyaket's FAQ](https://pyaket.tremeschin.com/faq/macos/)
7-
86
!!! warning "Help me with apple hardware"
9-
I don't have access to any macOS machine to ensure things work properly for such large userbase, and I can't afford to buy one given the _lack of sustainability_ of Open Source in general.
7+
I don't have access to any macOS machine to ensure things work properly for such large userbase, and I can't afford to buy one given the lack of support in the project yet.
108

119
-> [Support](https://github.com/sponsors/Tremeschin) my work or donate a used device for development!
1210

website/faq/windows.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Windows
33
icon: material/microsoft
44
---
55

6-
-> **Note**: For executables see [Pyaket's FAQ](https://pyaket.tremeschin.com/faq/windows/)
7-
86
### **Q:** Wrong GPU being used {#wrong-gpu}
97

108
Hybrid systems might offload lightweight tasks to the weaker or integrated gpu for performance, battery life, and efficiency reasons. Since ShaderFlow is a _'generic'_ Python application that simply uses [moderngl](https://github.com/moderngl/moderngl) contexts, the operating system is being lazy (in a good way) with its choice.

zensical.toml

Lines changed: 10 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ site_url = "https://shaders.tremeschin.com/"
66
repo_url = "https://github.com/BrokenSource/ShaderFlow/"
77
repo_name = "BrokenSource/ShaderFlow"
88
copyright = "&copy; CC BY-SA 4.0, <a href='https://github.com/Tremeschin/'>Tremeschin</a> 🇧🇷"
9-
extra_css = ["assets/main.css"]
109
docs_dir = "website"
1110
nav = [
1211
{Origin = "https://tremeschin.com/"},
@@ -33,55 +32,23 @@ nav = [
3332
"docs/texture.md",
3433
]},
3534
{Questions = [
36-
"faq/general.md",
37-
"faq/windows.md",
38-
"faq/linux.md",
39-
"faq/macos.md",
35+
"faq/index.md",
36+
{Base = [
37+
"faq/general.md",
38+
]},
39+
{Systems = [
40+
"faq/windows.md",
41+
"faq/linux.md",
42+
"faq/macos.md",
43+
]}
4044
]},
4145
]
42-
4346
[project.theme]
44-
variant = "modern"
47+
name = "zentheme"
4548
favicon = "assets/logo.png"
46-
features = [
47-
"announce.dismiss",
48-
"content.code.annotate",
49-
"content.code.copy",
50-
"content.footnote.tooltips",
51-
"content.tabs.link",
52-
"content.tooltips",
53-
"navigation.expand",
54-
"navigation.footer",
55-
"navigation.indexes",
56-
"navigation.instant.prefetch",
57-
"navigation.instant.progress",
58-
"navigation.instant",
59-
"navigation.path",
60-
"navigation.tabs",
61-
"navigation.top",
62-
"search.highlight",
63-
"toc.follow",
64-
]
6549

6650
[project.theme.icon]
6751
logo = "octicons/flame-16"
68-
repo = "fontawesome/brands/github"
69-
70-
[[project.theme.palette]]
71-
toggle.icon = "lucide/sun"
72-
toggle.name = "Switch to dark mode"
73-
media = "(prefers-color-scheme: light)"
74-
scheme = "default"
75-
primary = "blue"
76-
accent = "light-blue"
77-
78-
[[project.theme.palette]]
79-
toggle.icon = "lucide/moon"
80-
toggle.name = "Switch to light mode"
81-
media = "(prefers-color-scheme: dark)"
82-
scheme = "slate"
83-
primary = "orange"
84-
accent = "orange"
8552

8653
[[project.extra.social]]
8754
icon = "fontawesome/brands/discord"

0 commit comments

Comments
 (0)