Browse Source

[Docs] reSTify oldwiki/Graphene-Quick-Start.md

Wojtek Porczyk 4 years ago
parent
commit
76af85e6b7

+ 1 - 0
Documentation/index.rst

@@ -4,6 +4,7 @@
    :caption: Introduction
    :maxdepth: 2
 
+   quickstart
    debugging
    glossary
    howto-doc

+ 0 - 32
Documentation/oldwiki/Graphene-Quick-Start.md

@@ -1,32 +0,0 @@
-# Graphene Quick Start
-
-(The following quick start instruction does not include the steps for running Graphene with
-sandboxing because sandboxing is an experimental feature.)
-
-### 1. Clone the Graphene Repository
-
-    git clone https://github.com/oscarlab/graphene.git
-
-### 2. Build Graphene
-
-    cd graphene
-    make
-
-### 3. Build and Run `helloworld`
-
-    cd LibOS/shim/test/native
-    make
-    ./pal_loader helloworld
-
-### 4. Test LMBench Application
-
-    cd ..
-    git submodule update --init apps
-    cd apps/lmbench
-    make
-    cd lmbench-2.5/bin/linux
-    ./pal_loader lat_syscall null
-    ./pal_loader lat_syscall open
-    ./pal_loader lat_syscall read
-    ./pal_loader lat_proc fork
-

+ 1 - 1
Documentation/oldwiki/Introduction-to-Graphene.md

@@ -61,7 +61,7 @@ To run tests, you also need the python3-pytest package:
 
 ## Build and Run Graphene
 
-See [Graphene Quick Start](Graphene-Quick-Start.md) for instructions how to quickly build and run Graphene.
+See [Graphene Quick Start](../quickstart) for instructions how to quickly build and run Graphene.
 
 ### Obtain Source Code
 

+ 34 - 0
Documentation/quickstart.rst

@@ -0,0 +1,34 @@
+Quick Start
+===========
+
+.. highlight:: sh
+
+(The following quick start instruction does not include the steps for running Graphene with
+sandboxing because sandboxing is an experimental feature.)
+
+1. Clone the Graphene Repository::
+
+      git clone https://github.com/oscarlab/graphene.git
+
+2. Build Graphene::
+
+      cd graphene
+      make
+
+3. Build and Run `helloworld`::
+
+      cd LibOS/shim/test/native
+      make
+      ./pal_loader helloworld
+
+4. Test LMBench Application::
+
+      cd ..
+      git submodule update --init apps
+      cd apps/lmbench
+      make
+      cd lmbench-2.5/bin/linux
+      ./pal_loader lat_syscall null
+      ./pal_loader lat_syscall open
+      ./pal_loader lat_syscall read
+      ./pal_loader lat_proc fork