From b496a3da1e1749042ecf46f524356d19300f1532 Mon Sep 17 00:00:00 2001 From: Frank Galligan Date: Wed, 7 Feb 2018 10:05:29 -0800 Subject: [PATCH] Add a command line applicatiosn guide. --- docs/guides/COMMAND_LINE_APPLICATIONS.md | 45 ++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs/guides/COMMAND_LINE_APPLICATIONS.md diff --git a/docs/guides/COMMAND_LINE_APPLICATIONS.md b/docs/guides/COMMAND_LINE_APPLICATIONS.md new file mode 100644 index 0000000..375bcc3 --- /dev/null +++ b/docs/guides/COMMAND_LINE_APPLICATIONS.md @@ -0,0 +1,45 @@ +# Using Draco Command Line Applications + +This guide will show you how to build, and use the Draco command line +applications to encode and decode Draco files. + +## Building + +Clone the Github repository using this command line: +``` +git clone git@github.com:/draco.git +``` +_**Note** that we **strongly** recommend [using SSH] with GitHub, not HTTPS._ + + +Build the command line applications with these commands: +``` +cd draco +``` + +It is best to create an isolated build directory. +``` +mkdir build +cd build +``` + +Run cmake to build `draco_encoder` and `draco_decoder`. +``` +cmake .. +make +``` + +## Encode Draco File + +Encode a mesh file using the default settings. `draco_encoder` will read OBJ or PLY files as input, and output Draco files. We have included Stanford's Bunny mesh for testing. The basic command line looks like this: +``` +./draco_encoder -i ../testdata/bun_zipper.ply -o bunny.drc +``` + + +## Decode Draco File + +`draco_decoder` will read Draco files as input, and output OBJ or PLY files. The basic command line looks like this: +``` +./draco_encoder -i bunny.drc -o bunny.ply +```