aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobin H. Johnson <robbat2@gentoo.org>2023-12-31 05:15:54 +0000
committerRobin H. Johnson <robbat2@gentoo.org>2023-12-31 05:15:54 +0000
commit62565e273a997badcec2aff5a90684b4a5fb49e4 (patch)
tree12087dca89406c050dc5cc99b17c8fefb8a392e5
parentsnapshot from 2023-12-31T05:01:13+00:00 (diff)
downloadassets-62565e273a997badcec2aff5a90684b4a5fb49e4.tar.gz
assets-62565e273a997badcec2aff5a90684b4a5fb49e4.tar.bz2
assets-62565e273a997badcec2aff5a90684b4a5fb49e4.zip
README: document the repo
Signed-off-by: Robin H. Johnson <robbat2@gentoo.org>
-rw-r--r--README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3cef655
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# assets.gentoo.org
+
+This repo (and website) hold the pre-built website style/theme assets for
+`gentoo.org` websites.
+
+## Git Repositories
+- [Assets](https://gitweb.gentoo.org/sites/assets.git/)
+- [Tyrian theme source](https://gitweb.gentoo.org/sites/tyrian-theme.git/)
+
+## Index
+### Active assets
+```
+/_index.html - redirect to https://gentoo.org
+/lunr/ - https://devmanual.gentoo.org search engine code
+/tyrian/v2/
+/tyrian/v2.0.0/
+/tyrian/v2.0.1/
+/tyrian/v2.0.2/
+```
+
+### Legacy assets
+Do not use these assets for new sites. They are still present until we can confirm nothing uses them.
+```
+/assets/tyrian/
+/bootstrap.min.css
+/bootstrap.min.js
+/retina.min.js
+/tyrian.min.css
+/tyrian/*.css
+/tyrian/*.eot
+/tyrian/*.js
+/tyrian/*.map
+/tyrian/*.otf
+/tyrian/*.png
+/tyrian/*.svg
+/tyrian/*.ttf
+/tyrian/*.woff
+/tyrian/*.woff2
+/tyrian/v1/
+/tyrian/v1.0.0/
+````