Introduction and config stuff

deploy.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env sh
+
+# abort on errors
+set -e
+
+# build
+npm run docs:build
+
+# navigate into the build output directory
+cd docs/.vuepress/dist
+
+# if you are deploying to a custom domain
+# echo 'www.example.com' > CNAME
+
+git init
+git add -A
+git commit -m 'deploy'
+
+# if you are deploying to https://<USERNAME>.github.io
+# git push -f git@github.com:<USERNAME>/<USERNAME>.github.io.git master
+
+# if you are deploying to https://<USERNAME>.github.io/<REPO>
+git push -f git@github.com:sotrh/learn-wgpu.git master:gh-pages
+
+cd -

docs/.vuepress/config.js

@@ -1,6 +1,8 @@
 module.exports = {
+    base: '/learn-wgpu/',
     themeConfig: {
-        displayAllHeaders: true,
+        displayAllHeaders: false,
+        lastUpdated: 'Last Updated',
         sidebar: [
             '/',
             {

docs/.vuepress/dist

@@ -0,0 +1 @@
+Subproject commit 86bf16112101531159df6609e990ce7deadc2e01

docs/README.md

@@ -1 +1,11 @@
-# Introduction
+# Introduction
+
+## What is wgpu?
+[Wgpu](https://github.com/gfx-rs/wgpu) is a Rust implementation of the [WebGPU API spec](https://gpuweb.github.io/gpuweb/). WebGPU is a specification published by the GPU for the Web Community Group. It aims to allow web code access to GPU functions in a safe and reliable manner. It does this by mimicking the Vulkan API, and translating that down to whatever API the host hardware is using (ie. DirectX, Metal, Vulkan, OpenGL*).
+
+Wgpu is still in development, so some of this doc is subject to change.
+
+## Why Rust?
+Wgpu actually has C bindings to allow you to write C/C++ code with it, as well as use other languages that interface with C. That being said, wgpu is written in Rust, and it has some convient Rust Bindings that don't have to jump through any hoops. On top of that, I've been enjoying writing in Rust.
+
+I'm using this project as a way to learn wgpu myself, so I might miss some important details, or explain things wrong. I'm always open to constructive feedback. That being said, let's get started!