Skip to content

Commit 4be40ca

Browse files
committed
Create Jekyll page for vrperfkit and add overview and installation instructions
1 parent 733a870 commit 4be40ca

File tree

11 files changed

+480
-0
lines changed

11 files changed

+480
-0
lines changed

docs/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
_site
2+
.sass-cache
3+
.jekyll-cache
4+
.jekyll-metadata
5+
vendor

docs/Gemfile

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
source "https://rubygems.org"
2+
# Hello! This is where you manage which Jekyll version is used to run.
3+
# When you want to use a different version, change it below, save the
4+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
5+
#
6+
# bundle exec jekyll serve
7+
#
8+
# This will help ensure the proper Jekyll version is running.
9+
# Happy Jekylling!
10+
#gem "jekyll", "~> 4.2.1"
11+
# This is the default theme for new Jekyll sites. You may change this to anything you like.
12+
gem "minima", "~> 2.5"
13+
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
14+
# uncomment the line below. To upgrade, run `bundle update github-pages`.
15+
gem "github-pages", group: :jekyll_plugins
16+
# If you have any plugins, put them here!
17+
group :jekyll_plugins do
18+
gem "jekyll-feed", "~> 0.12"
19+
end
20+
21+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
22+
# and associated library.
23+
platforms :mingw, :x64_mingw, :mswin, :jruby do
24+
gem "tzinfo", "~> 1.2"
25+
gem "tzinfo-data"
26+
end
27+
28+
# Performance-booster for watching directories on Windows
29+
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
30+

docs/Gemfile.lock

Lines changed: 292 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,292 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (6.0.4.4)
5+
concurrent-ruby (~> 1.0, >= 1.0.2)
6+
i18n (>= 0.7, < 2)
7+
minitest (~> 5.1)
8+
tzinfo (~> 1.1)
9+
zeitwerk (~> 2.2, >= 2.2.2)
10+
addressable (2.8.0)
11+
public_suffix (>= 2.0.2, < 5.0)
12+
coffee-script (2.4.1)
13+
coffee-script-source
14+
execjs
15+
coffee-script-source (1.11.1)
16+
colorator (1.1.0)
17+
commonmarker (0.17.13)
18+
ruby-enum (~> 0.5)
19+
concurrent-ruby (1.1.9)
20+
dnsruby (1.61.9)
21+
simpleidn (~> 0.1)
22+
em-websocket (0.5.3)
23+
eventmachine (>= 0.12.9)
24+
http_parser.rb (~> 0)
25+
ethon (0.15.0)
26+
ffi (>= 1.15.0)
27+
eventmachine (1.2.7-x64-mingw32)
28+
execjs (2.8.1)
29+
faraday (1.9.3)
30+
faraday-em_http (~> 1.0)
31+
faraday-em_synchrony (~> 1.0)
32+
faraday-excon (~> 1.1)
33+
faraday-httpclient (~> 1.0)
34+
faraday-multipart (~> 1.0)
35+
faraday-net_http (~> 1.0)
36+
faraday-net_http_persistent (~> 1.0)
37+
faraday-patron (~> 1.0)
38+
faraday-rack (~> 1.0)
39+
faraday-retry (~> 1.0)
40+
ruby2_keywords (>= 0.0.4)
41+
faraday-em_http (1.0.0)
42+
faraday-em_synchrony (1.0.0)
43+
faraday-excon (1.1.0)
44+
faraday-httpclient (1.0.1)
45+
faraday-multipart (1.0.3)
46+
multipart-post (>= 1.2, < 3)
47+
faraday-net_http (1.0.1)
48+
faraday-net_http_persistent (1.2.0)
49+
faraday-patron (1.0.0)
50+
faraday-rack (1.0.0)
51+
faraday-retry (1.0.3)
52+
ffi (1.15.5-x64-mingw32)
53+
forwardable-extended (2.6.0)
54+
gemoji (3.0.1)
55+
github-pages (223)
56+
github-pages-health-check (= 1.17.9)
57+
jekyll (= 3.9.0)
58+
jekyll-avatar (= 0.7.0)
59+
jekyll-coffeescript (= 1.1.1)
60+
jekyll-commonmark-ghpages (= 0.1.6)
61+
jekyll-default-layout (= 0.1.4)
62+
jekyll-feed (= 0.15.1)
63+
jekyll-gist (= 1.5.0)
64+
jekyll-github-metadata (= 2.13.0)
65+
jekyll-include-cache (= 0.2.1)
66+
jekyll-mentions (= 1.6.0)
67+
jekyll-optional-front-matter (= 0.3.2)
68+
jekyll-paginate (= 1.1.0)
69+
jekyll-readme-index (= 0.3.0)
70+
jekyll-redirect-from (= 0.16.0)
71+
jekyll-relative-links (= 0.6.1)
72+
jekyll-remote-theme (= 0.4.3)
73+
jekyll-sass-converter (= 1.5.2)
74+
jekyll-seo-tag (= 2.7.1)
75+
jekyll-sitemap (= 1.4.0)
76+
jekyll-swiss (= 1.0.0)
77+
jekyll-theme-architect (= 0.2.0)
78+
jekyll-theme-cayman (= 0.2.0)
79+
jekyll-theme-dinky (= 0.2.0)
80+
jekyll-theme-hacker (= 0.2.0)
81+
jekyll-theme-leap-day (= 0.2.0)
82+
jekyll-theme-merlot (= 0.2.0)
83+
jekyll-theme-midnight (= 0.2.0)
84+
jekyll-theme-minimal (= 0.2.0)
85+
jekyll-theme-modernist (= 0.2.0)
86+
jekyll-theme-primer (= 0.6.0)
87+
jekyll-theme-slate (= 0.2.0)
88+
jekyll-theme-tactile (= 0.2.0)
89+
jekyll-theme-time-machine (= 0.2.0)
90+
jekyll-titles-from-headings (= 0.5.3)
91+
jemoji (= 0.12.0)
92+
kramdown (= 2.3.1)
93+
kramdown-parser-gfm (= 1.1.0)
94+
liquid (= 4.0.3)
95+
mercenary (~> 0.3)
96+
minima (= 2.5.1)
97+
nokogiri (>= 1.12.5, < 2.0)
98+
rouge (= 3.26.0)
99+
terminal-table (~> 1.4)
100+
github-pages-health-check (1.17.9)
101+
addressable (~> 2.3)
102+
dnsruby (~> 1.60)
103+
octokit (~> 4.0)
104+
public_suffix (>= 3.0, < 5.0)
105+
typhoeus (~> 1.3)
106+
html-pipeline (2.14.0)
107+
activesupport (>= 2)
108+
nokogiri (>= 1.4)
109+
http_parser.rb (0.8.0)
110+
i18n (0.9.5)
111+
concurrent-ruby (~> 1.0)
112+
jekyll (3.9.0)
113+
addressable (~> 2.4)
114+
colorator (~> 1.0)
115+
em-websocket (~> 0.5)
116+
i18n (~> 0.7)
117+
jekyll-sass-converter (~> 1.0)
118+
jekyll-watch (~> 2.0)
119+
kramdown (>= 1.17, < 3)
120+
liquid (~> 4.0)
121+
mercenary (~> 0.3.3)
122+
pathutil (~> 0.9)
123+
rouge (>= 1.7, < 4)
124+
safe_yaml (~> 1.0)
125+
jekyll-avatar (0.7.0)
126+
jekyll (>= 3.0, < 5.0)
127+
jekyll-coffeescript (1.1.1)
128+
coffee-script (~> 2.2)
129+
coffee-script-source (~> 1.11.1)
130+
jekyll-commonmark (1.3.1)
131+
commonmarker (~> 0.14)
132+
jekyll (>= 3.7, < 5.0)
133+
jekyll-commonmark-ghpages (0.1.6)
134+
commonmarker (~> 0.17.6)
135+
jekyll-commonmark (~> 1.2)
136+
rouge (>= 2.0, < 4.0)
137+
jekyll-default-layout (0.1.4)
138+
jekyll (~> 3.0)
139+
jekyll-feed (0.15.1)
140+
jekyll (>= 3.7, < 5.0)
141+
jekyll-gist (1.5.0)
142+
octokit (~> 4.2)
143+
jekyll-github-metadata (2.13.0)
144+
jekyll (>= 3.4, < 5.0)
145+
octokit (~> 4.0, != 4.4.0)
146+
jekyll-include-cache (0.2.1)
147+
jekyll (>= 3.7, < 5.0)
148+
jekyll-mentions (1.6.0)
149+
html-pipeline (~> 2.3)
150+
jekyll (>= 3.7, < 5.0)
151+
jekyll-optional-front-matter (0.3.2)
152+
jekyll (>= 3.0, < 5.0)
153+
jekyll-paginate (1.1.0)
154+
jekyll-readme-index (0.3.0)
155+
jekyll (>= 3.0, < 5.0)
156+
jekyll-redirect-from (0.16.0)
157+
jekyll (>= 3.3, < 5.0)
158+
jekyll-relative-links (0.6.1)
159+
jekyll (>= 3.3, < 5.0)
160+
jekyll-remote-theme (0.4.3)
161+
addressable (~> 2.0)
162+
jekyll (>= 3.5, < 5.0)
163+
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
164+
rubyzip (>= 1.3.0, < 3.0)
165+
jekyll-sass-converter (1.5.2)
166+
sass (~> 3.4)
167+
jekyll-seo-tag (2.7.1)
168+
jekyll (>= 3.8, < 5.0)
169+
jekyll-sitemap (1.4.0)
170+
jekyll (>= 3.7, < 5.0)
171+
jekyll-swiss (1.0.0)
172+
jekyll-theme-architect (0.2.0)
173+
jekyll (> 3.5, < 5.0)
174+
jekyll-seo-tag (~> 2.0)
175+
jekyll-theme-cayman (0.2.0)
176+
jekyll (> 3.5, < 5.0)
177+
jekyll-seo-tag (~> 2.0)
178+
jekyll-theme-dinky (0.2.0)
179+
jekyll (> 3.5, < 5.0)
180+
jekyll-seo-tag (~> 2.0)
181+
jekyll-theme-hacker (0.2.0)
182+
jekyll (> 3.5, < 5.0)
183+
jekyll-seo-tag (~> 2.0)
184+
jekyll-theme-leap-day (0.2.0)
185+
jekyll (> 3.5, < 5.0)
186+
jekyll-seo-tag (~> 2.0)
187+
jekyll-theme-merlot (0.2.0)
188+
jekyll (> 3.5, < 5.0)
189+
jekyll-seo-tag (~> 2.0)
190+
jekyll-theme-midnight (0.2.0)
191+
jekyll (> 3.5, < 5.0)
192+
jekyll-seo-tag (~> 2.0)
193+
jekyll-theme-minimal (0.2.0)
194+
jekyll (> 3.5, < 5.0)
195+
jekyll-seo-tag (~> 2.0)
196+
jekyll-theme-modernist (0.2.0)
197+
jekyll (> 3.5, < 5.0)
198+
jekyll-seo-tag (~> 2.0)
199+
jekyll-theme-primer (0.6.0)
200+
jekyll (> 3.5, < 5.0)
201+
jekyll-github-metadata (~> 2.9)
202+
jekyll-seo-tag (~> 2.0)
203+
jekyll-theme-slate (0.2.0)
204+
jekyll (> 3.5, < 5.0)
205+
jekyll-seo-tag (~> 2.0)
206+
jekyll-theme-tactile (0.2.0)
207+
jekyll (> 3.5, < 5.0)
208+
jekyll-seo-tag (~> 2.0)
209+
jekyll-theme-time-machine (0.2.0)
210+
jekyll (> 3.5, < 5.0)
211+
jekyll-seo-tag (~> 2.0)
212+
jekyll-titles-from-headings (0.5.3)
213+
jekyll (>= 3.3, < 5.0)
214+
jekyll-watch (2.2.1)
215+
listen (~> 3.0)
216+
jemoji (0.12.0)
217+
gemoji (~> 3.0)
218+
html-pipeline (~> 2.2)
219+
jekyll (>= 3.0, < 5.0)
220+
kramdown (2.3.1)
221+
rexml
222+
kramdown-parser-gfm (1.1.0)
223+
kramdown (~> 2.0)
224+
liquid (4.0.3)
225+
listen (3.7.1)
226+
rb-fsevent (~> 0.10, >= 0.10.3)
227+
rb-inotify (~> 0.9, >= 0.9.10)
228+
mercenary (0.3.6)
229+
minima (2.5.1)
230+
jekyll (>= 3.5, < 5.0)
231+
jekyll-feed (~> 0.9)
232+
jekyll-seo-tag (~> 2.1)
233+
minitest (5.15.0)
234+
multipart-post (2.1.1)
235+
nokogiri (1.13.1-x64-mingw32)
236+
racc (~> 1.4)
237+
octokit (4.22.0)
238+
faraday (>= 0.9)
239+
sawyer (~> 0.8.0, >= 0.5.3)
240+
pathutil (0.16.2)
241+
forwardable-extended (~> 2.6)
242+
public_suffix (4.0.6)
243+
racc (1.6.0)
244+
rb-fsevent (0.11.0)
245+
rb-inotify (0.10.1)
246+
ffi (~> 1.0)
247+
rexml (3.2.5)
248+
rouge (3.26.0)
249+
ruby-enum (0.9.0)
250+
i18n
251+
ruby2_keywords (0.0.5)
252+
rubyzip (2.3.2)
253+
safe_yaml (1.0.5)
254+
sass (3.7.4)
255+
sass-listen (~> 4.0.0)
256+
sass-listen (4.0.0)
257+
rb-fsevent (~> 0.9, >= 0.9.4)
258+
rb-inotify (~> 0.9, >= 0.9.7)
259+
sawyer (0.8.2)
260+
addressable (>= 2.3.5)
261+
faraday (> 0.8, < 2.0)
262+
simpleidn (0.2.1)
263+
unf (~> 0.1.4)
264+
terminal-table (1.8.0)
265+
unicode-display_width (~> 1.1, >= 1.1.1)
266+
thread_safe (0.3.6)
267+
typhoeus (1.4.0)
268+
ethon (>= 0.9.0)
269+
tzinfo (1.2.9)
270+
thread_safe (~> 0.1)
271+
tzinfo-data (1.2021.5)
272+
tzinfo (>= 1.0.0)
273+
unf (0.1.4)
274+
unf_ext
275+
unf_ext (0.0.8-x64-mingw32)
276+
unicode-display_width (1.8.0)
277+
wdm (0.1.1)
278+
zeitwerk (2.5.3)
279+
280+
PLATFORMS
281+
x64-mingw32
282+
283+
DEPENDENCIES
284+
github-pages
285+
jekyll-feed (~> 0.12)
286+
minima (~> 2.5)
287+
tzinfo (~> 1.2)
288+
tzinfo-data
289+
wdm (~> 0.1.1)
290+
291+
BUNDLED WITH
292+
2.3.5

docs/_config.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
title: VR Performance Toolkit
2+
description: >- # this means to ignore newlines until "baseurl:"
3+
A collection of tools to help you make your PCVR games run faster without
4+
sacrificing too much visual quality.
5+
6+
# Build settings
7+
remote_theme: pages-themes/midnight@v0.2.0
8+
plugins:
9+
- jekyll-remote-theme

docs/_layouts/default.html

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!doctype html>
2+
<html lang="{{ site.lang | default: "en-US" }}">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
7+
{% seo %}
8+
<link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
9+
<script src="https://code.jquery.com/jquery-1.12.4.min.js" integrity="sha256-ZosEbRLbNQzLpnKIkEdrPv7lOy9C27hHQ+Xp8a4MxAQ=" crossorigin="anonymous"></script>
10+
<script src="{{ '/assets/js/respond.js' | relative_url }}"></script>
11+
<!--[if lt IE 9]>
12+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13+
<![endif]-->
14+
<!--[if lt IE 8]>
15+
<link rel="stylesheet" href="{{ '/assets/css/ie.css' | relative_url }}">
16+
<![endif]-->
17+
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
18+
{% include head-custom.html %}
19+
</head>
20+
<body>
21+
<div id="header">
22+
<nav>
23+
<ul>
24+
<li class="fork"><a href="{{ site.github.repository_url }}">View On GitHub</a></li>
25+
<li class="downloads"><a href="{{ site.github.repository_url }}/releases/latest">Latest</a></li>
26+
<li class="title">DOWNLOAD</li>
27+
</ul>
28+
</nav>
29+
</div><!-- end header -->
30+
31+
<div class="wrapper">
32+
33+
<section>
34+
<div id="title">
35+
<h1><a href="/">{{ site.title | default: site.github.repository_name }}</a></h1>
36+
<p>{{ site.description | default: site.github.project_tagline }}</p>
37+
<hr>
38+
<span class="credits left">Project maintained by <a href="{{ site.github.owner_url }}">Holger Frydrych</a></span>
39+
<span class="credits right">Hosted on GitHub Pages &mdash; Theme by <a href="https://twitter.com/mattgraham">mattgraham</a></span>
40+
</div>
41+
42+
{{ content }}
43+
44+
</section>
45+
46+
</div>
47+
</body>
48+
</html>

docs/config.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
permalink: /configure/
3+
---
4+
5+
# Configuration guide

docs/images/example_unreal_1.jpg

14.9 KB
Loading
94.2 KB
Loading
30.3 KB
Loading

0 commit comments

Comments
 (0)