mirror of https://github.com/inolen/redream.git
moving redream website sources into docs/
This commit is contained in:
Anthony Pesch
parent
48483d7322
commit
2b4ce08727
|
|
@ -0,0 +1,3 @@
|
|||
Gemfile
|
||||
Gemfile.lock
|
||||
_site/
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
title: redream.io
|
||||
baseurl: ""
|
||||
url:
|
||||
|
||||
disqus:
|
||||
shortname: redream
|
||||
|
||||
collections:
|
||||
docs:
|
||||
output: true
|
||||
|
||||
defaults:
|
||||
- scope:
|
||||
path: ""
|
||||
type: posts
|
||||
values:
|
||||
permalink: /:collection/:title
|
||||
layout: post
|
||||
- scope:
|
||||
path: ""
|
||||
type: docs
|
||||
values:
|
||||
permalink: /:collection/:title
|
||||
layout: doc
|
||||
|
||||
markdown: kramdown
|
||||
|
||||
exclude:
|
||||
- Gemfile
|
||||
- Gemfile.lock
|
||||
|
|
@ -1,4 +1,6 @@
|
|||
# Building
|
||||
---
|
||||
title: Building
|
||||
---
|
||||
|
||||
Start by cloning the repository and setting up a build directory.
|
||||
```
|
||||
|
|
@ -1,3 +1,5 @@
|
|||
## Community
|
||||
---
|
||||
title: Community
|
||||
---
|
||||
|
||||
Ask questions and help answer them on [Slack](http://slack.redream.io).
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
title: CPU Design
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
title: Memory Design
|
||||
---
|
||||
|
|
@ -1,4 +1,8 @@
|
|||
# Design
|
||||
---
|
||||
title: Design
|
||||
---
|
||||
|
||||
## Directory structure
|
||||
|
||||
### audio
|
||||
|
||||
|
|
@ -1,4 +1,6 @@
|
|||
# Running
|
||||
---
|
||||
title: Running
|
||||
---
|
||||
|
||||
```
|
||||
redream --bios=path/to/dc_boot.bin --flash=path/to/dc_flash.bin <bin or gdi file>
|
||||
|
|
@ -1,4 +1,6 @@
|
|||
# Testing
|
||||
---
|
||||
title: Testing
|
||||
---
|
||||
|
||||
The `test` directory contains unit tests for some of redream's core data structures, as well as assembly-based tests for the SH4 instruction set.
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
{% if page.comments != false %}
|
||||
<div id="disqus_thread"></div>
|
||||
<script>
|
||||
var disqus_config = function () {
|
||||
this.page.url = '{{ page.url | absolute_url }}';
|
||||
this.page.identifier = '{{ page.url | absolute_url }}';
|
||||
};
|
||||
|
||||
(function() {
|
||||
var d = document, s = d.createElement('script');
|
||||
|
||||
s.src = 'https://{{ site.disqus.shortname }}.disqus.com/embed.js';
|
||||
|
||||
s.setAttribute('data-timestamp', +new Date());
|
||||
(d.head || d.body).appendChild(s);
|
||||
})();
|
||||
</script>
|
||||
<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>
|
||||
{% endif %}
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans|Roboto:400,900">
|
||||
<link rel="stylesheet" href="http://yandex.st/highlightjs/8.0/styles/github.min.css"></link>
|
||||
<link rel="stylesheet" href="{{ site.github.url }}/css/main.css"></link>
|
||||
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
|
||||
<link rel="icon" href="{{ site.github.url }}/favicon.ico" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
<div id="header">
|
||||
<div class="container">
|
||||
<div id="banner">
|
||||
<a href="{{ site.github.url }}/"><img src="{{ site.github.url }}/img/logo.png" /></a>
|
||||
</div>
|
||||
<div id="navbar">
|
||||
<a href="{{ site.github.url }}/download">Download</a>
|
||||
<a href="{{ site.github.url }}/media">Media</a>
|
||||
<a href="{{ site.github.url }}/docs">Docs</a>
|
||||
<a class="slack" href="http://slack.redream.io"><img src="http://slack.redream.io/badge.svg"></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="content" class="container">
|
||||
<div>
|
||||
{{ content }}
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
layout: default
|
||||
---
|
||||
|
||||
<ul id="docs">
|
||||
<li><a {% if page.url.end_with? '/docs' %} class="current"{% endif %} href="{{ site.github.url }}/docs">About</a></li>
|
||||
<li><a {% if page.url.end_with? '/docs/building' %} class="current"{% endif %} href="{{ site.github.url }}/docs/building">Building</a></li>
|
||||
<li><a {% if page.url.end_with? '/docs/running' %} class="current"{% endif %} href="{{ site.github.url }}/docs/running">Running</a></li>
|
||||
<li><a {% if page.url.end_with? '/docs/testing' %} class="current"{% endif %} href="{{ site.github.url }}/docs/testing">Testing</a></li>
|
||||
<li>
|
||||
<li><a {% if page.url.end_with? '/docs/design' %} class="current"{% endif %} href="{{ site.github.url }}/docs/design">Design</a></li>
|
||||
<ul>
|
||||
<li><a {% if page.url.end_with? '/docs/design-cpu' %} class="current"{% endif %} href="{{ site.github.url }}/docs/design-cpu">CPU</a></li>
|
||||
<li><a {% if page.url.end_with? '/docs/design-memory' %} class="current"{% endif %} href="{{ site.github.url }}/docs/design-memory">Memory</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<article class="article doc">
|
||||
<header>
|
||||
<h1>{{ page.title | escape }}</h1>
|
||||
</header>
|
||||
|
||||
<div class="article-content">
|
||||
{{ content }}
|
||||
</div>
|
||||
</article>
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: default
|
||||
---
|
||||
|
||||
<article class="article">
|
||||
<header>
|
||||
<h1>{{ page.title | escape }}</h1>
|
||||
<time datetime="{{ page.date | date_to_xmlschema }}">{{ page.date | date: "%B %-d, %Y" }}</time>
|
||||
</header>
|
||||
|
||||
<div class="article-content">
|
||||
{{ content }}
|
||||
</div>
|
||||
|
||||
{% if site.disqus.shortname %}
|
||||
{% include disqus-comments.html %}
|
||||
{% endif %}
|
||||
</article>
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
title: "Getting started contributing to an emulator"
|
||||
date: 2016-12-05
|
||||
---
|
||||
|
||||
I've been browsing [r/emulation](https://www.reddit.com/r/emulation) a lot lately, and a common question I see is ["I want to help a project, but I have no idea where to begin"](https://www.reddit.com/r/emulation/comments/5fafea/its_pretty_strange_how_dreamcast_emulation_on_pc/dalaywa/). With the holidays approaching, I wanted to provide an answer for any would-be emulator developer looking to hack on something during them.
|
||||
|
||||
It's important to start off by mentioning that it's not a requirement to possess excellent low-level programming skills or in-depth knowledge of the hardware being emulated in order to contribute to emulators. Emulator projects are like any other sufficiently complicated project, there is a ton of work to do for all skill levels.
|
||||
|
||||
With that said however, it can be overwhelming to look at an emulation project and find an appropriate place to start contributing. To help bridge that gap, I've been creating more-detailed-than-normal issues in [redream's issue queue](https://github.com/inolen/redream/issues) this past week. These issues are tagged by difficulty level (easy, medium and hard), and prefixed by the section of code they apply to.
|
||||
|
||||
## Documentation
|
||||
|
||||
* [docs: add initial compatibility chart (easy)](https://github.com/inolen/redream/issues/37)
|
||||
|
||||
## UI
|
||||
|
||||
* [ui: fullscreen elements don't scale properly as window size changes (easy)](https://github.com/inolen/redream/issues/34)
|
||||
|
||||
## Input
|
||||
|
||||
* [maple: uniquely name vmu save files (easy)](https://github.com/inolen/redream/issues/31)
|
||||
* [maple: multiple controller profiles (easy)](https://github.com/inolen/redream/issues/32)
|
||||
* [maple: add joystick connected / disconnected events (medium)](https://github.com/inolen/redream/issues/33)
|
||||
|
||||
## Graphics
|
||||
|
||||
* [pvr: add missing palette texture converters (easy)](https://github.com/inolen/redream/issues/30)
|
||||
* [pvr: support shading instructions (medium)](https://github.com/inolen/redream/issues/35)
|
||||
* [pvr: support alpha testing for punch-through polygons (medium)](https://github.com/inolen/redream/issues/36)
|
||||
|
||||
## JIT
|
||||
|
||||
* [jit: expession simplification pass (medium)](https://github.com/inolen/redream/issues/39)
|
||||
|
||||
If you would like to chat more about any of these issues you can find me on our [Slack group](http://slack.redream.io/) channel under `@inolen`.
|
||||
|
|
@ -0,0 +1,169 @@
|
|||
body {
|
||||
margin: 0;
|
||||
color: #464646;
|
||||
font-family: 'Open Sans', sans-serif;
|
||||
}
|
||||
|
||||
a {
|
||||
text-decoration: none;
|
||||
color: #3a76c3;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #202020;
|
||||
}
|
||||
|
||||
h1, h2, h3 {
|
||||
color: #202020;
|
||||
font-family: 'Roboto' sans-serif;
|
||||
line-height: 1em;
|
||||
}
|
||||
|
||||
h1 a, h2 a, h3 a {
|
||||
color: #202020;
|
||||
}
|
||||
|
||||
code {
|
||||
padding: 3px 4px;
|
||||
color: #d14;
|
||||
background-color: #f7f7f9;
|
||||
border: 1px solid #e1e1e8;
|
||||
}
|
||||
|
||||
pre code {
|
||||
padding: 0;
|
||||
color: inherit;
|
||||
background-color: transparent;
|
||||
border: 0;
|
||||
}
|
||||
|
||||
.container {
|
||||
width: 1100px;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
#header {
|
||||
background-color: #f8f8f8;
|
||||
border-bottom: solid 1px #ededed;
|
||||
margin-bottom: 30px;
|
||||
}
|
||||
|
||||
#header .container {
|
||||
display: table;
|
||||
}
|
||||
|
||||
#banner {
|
||||
float: left;
|
||||
padding: 10px 0 10px 10px;
|
||||
}
|
||||
|
||||
#navbar {
|
||||
float: right;
|
||||
color: #202020;
|
||||
font-family: 'Roboto', sans-serif;
|
||||
font-weight: bold;
|
||||
font-size: 1.4em;
|
||||
text-align: center;
|
||||
text-transform: uppercase;
|
||||
padding: 32px 10px 32px 0;
|
||||
}
|
||||
|
||||
#navbar a {
|
||||
margin: 0 10px;
|
||||
color: #202020;
|
||||
}
|
||||
|
||||
#navbar a:hover {
|
||||
color: #3a76c3;
|
||||
}
|
||||
|
||||
#navbar .slack {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
#content {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
/*
|
||||
* articles
|
||||
*/
|
||||
#articles {
|
||||
list-style: none;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
#articles li {
|
||||
margin: 0 0 1em;
|
||||
padding-bottom: 1em;
|
||||
border-bottom: solid 2px #e6e6e6;
|
||||
}
|
||||
|
||||
#articles li:last-child {
|
||||
border-bottom: 0;
|
||||
}
|
||||
|
||||
.article header h1,
|
||||
.article header h2 {
|
||||
margin-top: 0;
|
||||
margin-bottom: .4em;
|
||||
}
|
||||
|
||||
.article time {
|
||||
color: #b9b9b9;
|
||||
font-family: 'Roboto', sans-serif;
|
||||
}
|
||||
|
||||
.article pre {
|
||||
font-size: .8em;
|
||||
}
|
||||
|
||||
.article img {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.article pre {
|
||||
background-color: #f8f8f8;
|
||||
border: 1px solid #ddd;
|
||||
font-size: 13px;
|
||||
line-height: 19px;
|
||||
overflow: auto;
|
||||
padding: 6px 10px;
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
/*
|
||||
* docs
|
||||
*/
|
||||
|
||||
#docs {
|
||||
position: absolute;
|
||||
top: 0;
|
||||
left: 0;
|
||||
margin: 0;
|
||||
padding: 6px 10px;
|
||||
width: 200px;
|
||||
overflow: hidden;
|
||||
list-style: none;
|
||||
background-color: #f8f8f8;
|
||||
border: 1px solid #ddd;
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
#docs ul {
|
||||
list-style: none;
|
||||
margin: 0 0 0 20px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
#docs .current {
|
||||
color: #202020;
|
||||
}
|
||||
|
||||
.doc {
|
||||
margin-left: 250px;
|
||||
}
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
layout: doc
|
||||
---
|
||||
|
||||
Welcome!
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: Download
|
||||
layout: default
|
||||
---
|
||||
|
||||
## Source
|
||||
|
||||
The source code is hosted on [GitHub](https://github.com/inolen/redream).
|
||||
|
||||
View the [documentation](/docs/building) for instructions on building.
|
||||
|
||||
## Binaries
|
||||
|
||||
The latest binaries built by our continuous integration are available below.
|
||||
|
||||
Please note, there is currently no Windows continous integration, as such there are no binaries available for it. Instead, you must [build it manually](docs/building).
|
||||
|
||||
### Linux
|
||||
|
||||
[redream.x86_64-linux.tar.gz](http://redream.io/builds/redream.x86_64-linux.tar.gz)
|
||||
|
||||
### Mac
|
||||
|
||||
[redream.x86_64-darwin.tar.gz](http://redream.io/builds/redream.x86_64-darwin.tar.gz)
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
layout: default
|
||||
---
|
||||
|
||||
<ul id="articles">
|
||||
{% for post in site.posts %}
|
||||
<li>
|
||||
<article class="article article-short">
|
||||
<header>
|
||||
<h2><a href="{{ post.url | prepend: site.github.url }}">{{ post.title }}</a></h2>
|
||||
<time datetime="{{ post.date | data_to_xmlschema }}">{{ post.date | date: "%B %-d, %Y" }}</time>
|
||||
</header>
|
||||
|
||||
{{ post.excerpt }}
|
||||
|
||||
<a href="{{ post.url }}">Continue reading</a>
|
||||
</article>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Media
|
||||
layout: default
|
||||
---
|
||||
|
||||
<center>
|
||||
<iframe width="853" height="480" src="https://www.youtube.com/embed/F7No6570CcY" frameborder="0" allowfullscreen></iframe>
|
||||
</center>
|
||||
Loading…
Reference in New Issue