resources: Add outline of website
Signed-off-by: Jason Lowe-Power <jason@lowepower.com>
Change-Id: I04713e6cf4a0395ee23f2b11c434d7a837b272b6
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5-resources/+/43306
Reviewed-by: Bobby R. Bruce <bbruce@ucdavis.edu>
Maintainer: Bobby R. Bruce <bbruce@ucdavis.edu>
Tested-by: Bobby R. Bruce <bbruce@ucdavis.edu>
diff --git a/.gitignore b/.gitignore
index 66f149f..21a7bd7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,9 @@
*.pyc
m5out/
packer
+
+# For jekyll
+_site
+.jekyll-cache
+Gemfile.lock
+.sass-cache
diff --git a/Gemfile b/Gemfile
new file mode 100644
index 0000000..6bb9eb9
--- /dev/null
+++ b/Gemfile
@@ -0,0 +1,2 @@
+gem 'github-pages'
+source 'https://rubygems.org'
diff --git a/README.md b/README.md
index 0c7d6e3..692d712 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,7 @@
The structure of this repository is as follows:
* **src** : The resource sources.
+* **docs**: The documentation and website for gem5 resources (resources.gem5.org)
The following sections outline our versioning policy, how to make changes
to this repository, and describe each resource and how they may be built.
diff --git a/_config.yml b/_config.yml
new file mode 100644
index 0000000..bba92d6
--- /dev/null
+++ b/_config.yml
@@ -0,0 +1,20 @@
+url: "https://resources.gem5.org"
+baseurl: ""
+title: "gem5 Resources"
+
+# Defaults from gh-pages (for testing)
+lsi: false
+safe: true
+source: .
+incremental: false
+highlighter: rouge
+gist:
+ noscript: false
+kramdown:
+ math_engine: mathjax
+ syntax_highlighter: rouge
+
+sass:
+ sass_dir: web/_sass
+
+layouts_dir: web/_layouts
diff --git a/index.md b/index.md
new file mode 100644
index 0000000..101c5fc
--- /dev/null
+++ b/index.md
@@ -0,0 +1,44 @@
+---
+layout: default
+title: "gem5 resources"
+permalink: "/"
+---
+
+## gem5 Resources
+
+gem5 resources is a repository providing sources for artifacts known and proven compatible with the [gem5 architecture simulator](https://gem5.org).
+These resources are not necessary for the compilation or running of gem5, but may aid users in producing certain simulations.
+
+## Why gem5 Resources?
+
+gem5 has been designed with flexibility in mind. Users may simulate a wide variety of hardware, with an equally wide variety of workloads.
+However, requiring users to find and configure workloads for gem5 (their own disk images, their own OS boots, their own tests, etc.) is a significant investment, and a hurdle to many.
+
+The purpose of gem5 resources is therefore *to provide a stable set of commonly used resources, with proven and documented compatibility with gem5*.
+In addition to this, gem5 resources also puts emphasis on *reproducibility of experiments* by providing citable, stable resources, tied to a particular release of gem5.
+
+## Using gem5 resources
+
+If you find one of the gem5-resources useful be sure to cite both the resources (see the README) and the [gem5art and gem5-resources paper](https://arch.cs.ucdavis.edu/assets/papers/ispass21-gem5art.pdf).
+
+```bibtex
+@inproceedings{bruce2021gem5art,
+ title={Enabling Reproducible and Agile Full-System Simulation},
+ author={Bruce, Bobby R. and Akram, Ayaz and Nguyen, Hoa and Roarty, Kyle and Samani, Mahyar and Fariborz, Marjan and Trivikram, Reddy and Sinclair, Matthew D. and Lowe-Power, Jason},
+ booktitle={In Proceedings of the 2021 IEEE International Symposium on Performance Analysis of Systems and Software (ISPASS '21)},
+ year={2021},
+ organization={IEEE}
+}
+
+```
+
+## UNDER CONSTRUCTION
+
+This website is under construction.
+You can see the following links for the current information on gem5-resources.
+More information will be here soon!
+
+* [Documentation on gem5-resources](http://www.gem5.org/documentation/general_docs/gem5_resources/)
+* [Source for gem5-resources](https://gem5.googlesource.com/public/gem5-resources/+/refs/heads/stable/)
+* [README for gem5-resources]({{'README' | relative_url}})
+* [The gem5art and gem5-resources paper](https://arch.cs.ucdavis.edu/assets/papers/ispass21-gem5art.pdf)
diff --git a/web/_layouts/default.html b/web/_layouts/default.html
new file mode 100644
index 0000000..43b96b2
--- /dev/null
+++ b/web/_layouts/default.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+ <head>
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <meta charset="utf-8">
+ <title>{{ page.title }} - {{ site.title }}</title>
+ <link rel="stylesheet" href="{{ "/web/assets/css/main.css" | relative_url }}">
+ </head>
+ <body>
+ {{ content}}
+ </body>
+</html>
diff --git a/web/_sass/main.scss b/web/_sass/main.scss
new file mode 100644
index 0000000..126160d
--- /dev/null
+++ b/web/_sass/main.scss
@@ -0,0 +1,9 @@
+$backgroundColor: #ffffff;
+$bodyColor: #000000;
+$bodyFont: -apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
+
+body {
+ background: $backgroundColor;
+ color: $bodyColor;
+ font-family: $bodyFont;
+}
diff --git a/web/assets/css/main.scss b/web/assets/css/main.scss
new file mode 100644
index 0000000..9f41894
--- /dev/null
+++ b/web/assets/css/main.scss
@@ -0,0 +1,4 @@
+---
+---
+
+@import "main";
