From a8a5a7d276f910003e5325cf5574a5bec81be01a Mon Sep 17 00:00:00 2001 From: TheNumbat Date: Thu, 2 Jul 2020 19:05:42 -0700 Subject: [PATCH] website setup? --- README.md | 11 +---------- docs/building.md | 5 +++-- docs/guide/guide.md | 7 ++++--- docs/guide/layout.md | 5 +++-- 4 files changed, 11 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 6125993..11a694a 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,4 @@ editing, realistic path tracing, and dynamic animation. Implementing the functionality of the program constitutes the majority of the coursework for 15-462/662 Computer Graphics at Carnegie Mellon University -The [User Guide](docs/guide/guide.md) describes the intended functionality of the software to an end user. - -The components of the Developer Manual are exhaustively listed on the sidebar to the right, and are organized under the three main components of the software: - -- [MeshEdit](docs/meshedit/overview.md) -- [PathTracer](docs/pathtracer/overview.md) -- [Animation](docs/animation/overview.md) - -See the sidebar on the right for access to all material in this wiki. In particular, -please read through the [Project Philosophy](docs/philosophy.md) before you begin work. +Please visit the [documentation website](https://cmu-graphics.github.io/Scotty3D/). diff --git a/docs/building.md b/docs/building.md index 4e4f903..1832d9e 100644 --- a/docs/building.md +++ b/docs/building.md @@ -1,5 +1,6 @@ - -## Build Instructions +layout: page +title: "Building Scotty3D" +permalink: /build ![Ubuntu Build Status](https://github.com/CMU-Graphics/Scotty3D-dev/workflows/Ubuntu/badge.svg) ![MacOS Build Status](https://github.com/CMU-Graphics/Scotty3D-dev/workflows/MacOS/badge.svg) ![Windows Build Status](https://github.com/CMU-Graphics/Scotty3D-dev/workflows/Windows/badge.svg) diff --git a/docs/guide/guide.md b/docs/guide/guide.md index cb839d5..265e9a8 100644 --- a/docs/guide/guide.md +++ b/docs/guide/guide.md @@ -1,5 +1,6 @@ - -The User Guide provides some end-user information on how to use Scotty3D. +layout: page +title: "User Guide" +permalink: /guide ## Modes and Actions @@ -34,7 +35,7 @@ You can open the preferences window from the edit option in the menu bar. As is typical, all operations on scene objects, meshes, etc. are un and re-doable using Control/Command-Z to undo and Control/Command-Y to redo. These actions are also available from the `Edit` option in the menu bar. -## Mode Guides +## Specific Modes - [Layout](layout.md) - [Model](model.md) diff --git a/docs/guide/layout.md b/docs/guide/layout.md index 3a631de..5b03721 100644 --- a/docs/guide/layout.md +++ b/docs/guide/layout.md @@ -1,5 +1,6 @@ - -# Layout +layout: page +title: "Layout" +permalink: /guide/layout This is the main scene editing mode in Scotty3D, and does not contain tasks for the student to implement. This mode allows you to load full scenes from disk, create or load new objects, export your scene (COLLADA format), and edit transformations that place each object into your scene. -- GitLab