aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbnewbold <bnewbold@robocracy.org>2014-12-30 05:57:20 +0100
committerbnewbold <bnewbold@robocracy.org>2014-12-30 06:04:33 +0100
commit9919a64c93cd586c247f9c4893e8e983808608db (patch)
treea006bec62e1ffc47f7fd6d5313272882f8b3c475
parentdb28d0b7f7cb8d0a1e37541f4366ee8e43031cab (diff)
downloadnovena-guide-9919a64c93cd586c247f9c4893e8e983808608db.tar.gz
novena-guide-9919a64c93cd586c247f9c4893e8e983808608db.zip
overall skeleton
-rw-r--r--default-distro.rst12
-rw-r--r--fpga-hacking.rst11
-rw-r--r--hardware.rst12
-rw-r--r--index.rst21
-rw-r--r--porting.rst9
-rw-r--r--quickstart-board.rst7
-rw-r--r--quickstart-desktop.rst4
-rw-r--r--source-licensing.rst7
-rw-r--r--tasks.rst22
9 files changed, 99 insertions, 6 deletions
diff --git a/default-distro.rst b/default-distro.rst
new file mode 100644
index 0000000..623ee12
--- /dev/null
+++ b/default-distro.rst
@@ -0,0 +1,12 @@
+Default Distribution (Debian)
+=====================================
+
+Flashing Pre-Built Image to New Media
+--------------------------------------
+
+Links to default image; how to dd an image to a card.
+
+Building from Scratch
+------------------------
+
+http://kosagi.com/w/index.php?title=Novena_Main_Page#Linux_OS
diff --git a/fpga-hacking.rst b/fpga-hacking.rst
new file mode 100644
index 0000000..df38d0e
--- /dev/null
+++ b/fpga-hacking.rst
@@ -0,0 +1,11 @@
+FPGA Hacking
+===================
+
+- HDL template
+- pointers to toolchain setup and FPGA learning resources
+- kernel and userland details
+- performance and "numbers" table
+
+Expansion Header
+--------------------
+Pin outs
diff --git a/hardware.rst b/hardware.rst
new file mode 100644
index 0000000..029f19e
--- /dev/null
+++ b/hardware.rst
@@ -0,0 +1,12 @@
+
+The Hardware
+================
+
+Specs go here.
+
+Links to errata.
+
+Revisions
+--------------------
+
+How to identify variants (PVT1, PVT2, DVT, etc).
diff --git a/index.rst b/index.rst
index 9ffe8d9..9b0e608 100644
--- a/index.rst
+++ b/index.rst
@@ -1,14 +1,23 @@
-Documentation Main Page
+Documentation Contents
=========================
-Contents:
-
.. toctree::
:maxdepth: 2
-About This Document
----------------------
+ quickstart-desktop
+ quickstart-board
+ tasks
+ hardware
+ default-distro
+ fpga-hacking
+ porting
+ source-licensing
+
+About This Guide
+-------------------------------
+
+This is sphinx documentation. Build with ``make html``.
-.. include:: README.txt
+The web version is hosted on readthedocs using git hooks for autogeneration.
diff --git a/porting.rst b/porting.rst
new file mode 100644
index 0000000..07fb804
--- /dev/null
+++ b/porting.rst
@@ -0,0 +1,9 @@
+
+Porting Operating Systems
+============================
+
+GNU/Linux Distributions
+--------------------------
+
+Other Operating Systems
+--------------------------
diff --git a/quickstart-board.rst b/quickstart-board.rst
new file mode 100644
index 0000000..36b90eb
--- /dev/null
+++ b/quickstart-board.rst
@@ -0,0 +1,7 @@
+Quickstart: Just the Board
+=============================
+
+- shipped contents
+- first boot, getting a shell, networking
+- running from an SSD
+- checking for updates
diff --git a/quickstart-desktop.rst b/quickstart-desktop.rst
new file mode 100644
index 0000000..54b0df5
--- /dev/null
+++ b/quickstart-desktop.rst
@@ -0,0 +1,4 @@
+Quickstart: Desktop
+========================
+
+Assembly, screen, power on, networking, updates
diff --git a/source-licensing.rst b/source-licensing.rst
new file mode 100644
index 0000000..a5a94dc
--- /dev/null
+++ b/source-licensing.rst
@@ -0,0 +1,7 @@
+
+Source and Licensing
+===========================
+
+Links to source (hardware, firmware, software), licenses, and means for
+contributing patches.
+
diff --git a/tasks.rst b/tasks.rst
new file mode 100644
index 0000000..6b2cf3f
--- /dev/null
+++ b/tasks.rst
@@ -0,0 +1,22 @@
+
+Common Tasks
+================
+
+Installing an SSD
+---------------------------
+
+Changing microSD Card
+---------------------------
+
+Changing PCIe Card
+---------------------------
+
+Installing an Expansion Board
+--------------------------------
+
+Replacing Battery Pack
+---------------------------
+
+Pairing Bluetooth Device
+---------------------------
+