summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Monjalon <thomas@monjalon.net>2018-08-28 13:02:19 +0200
committerThomas Monjalon <thomas@monjalon.net>2018-08-28 13:12:25 +0200
commita04d808b8267d5fc1d3ab38ae671b270e462c89b (patch)
tree4903f5ae632f997c242f2d106be6face5e2a17bf
parent89b00809091d8776f5b646d6fd402e3bd9cb3ae8 (diff)
downloaddpdk-web-a04d808b8267d5fc1d3ab38ae671b270e462c89b.zip
dpdk-web-a04d808b8267d5fc1d3ab38ae671b270e462c89b.tar.gz
dpdk-web-a04d808b8267d5fc1d3ab38ae671b270e462c89b.tar.xz
add quick start doc about hugo
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
-rw-r--r--README28
1 files changed, 28 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1bc820d
--- /dev/null
+++ b/README
@@ -0,0 +1,28 @@
+The DPDK website core.dpdk.org is generated with Hugo (http://gohugo.io).
+
+
+Get source files
+----------------
+
+Clone the git project with the option --recurse-submodules
+or use the following commands after cloning:
+ git submodule init
+ git submodule update
+
+
+Generate web files
+------------------
+
+Just run hugo:
+ cd dpdk-web
+ hugo
+
+
+Browse web site locally
+-----------------------
+
+Run a local web server:
+ hugo server
+
+Open the local web files:
+ xdg-open http://localhost:1313