github.com/jgarto/itcv@v0.0.0-20180826224514-4eea09c1aa0d/_vendor/src/golang.org/x/tools/cmd/present/doc.go (about)

     1  // Copyright 2011 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  /*
     6  Present displays slide presentations and articles. It runs a web server that
     7  presents slide and article files from the current directory.
     8  
     9  It may be run as a stand-alone command or an App Engine app.
    10  
    11  Usage of present:
    12    -base="": base path for slide template and static resources
    13    -http="127.0.0.1:3999": HTTP service address (e.g., '127.0.0.1:3999')
    14    -nacl=false: use Native Client environment playground (prevents non-Go code execution)
    15    -notes=false: enable presenter notes (press 'N' from the browser to display them)
    16    -orighost="": host component of web origin URL (e.g., 'localhost')
    17    -play=true: enable playground (permit execution of arbitrary user code)
    18  
    19  The setup of the Go version of NaCl is documented at:
    20  https://golang.org/wiki/NativeClient
    21  
    22  To use with App Engine, copy the tools/cmd/present directory to the root of
    23  your application and create an app.yaml file similar to this:
    24  
    25      application: [application]
    26      version: [version]
    27      runtime: go
    28      api_version: go1
    29  
    30      handlers:
    31      - url: /favicon.ico
    32        static_files: present/static/favicon.ico
    33        upload: present/static/favicon.ico
    34      - url: /static
    35        static_dir: present/static
    36        application_readable: true
    37      - url: /.*
    38        script: _go_app
    39  
    40      # nobuild_files is a regexp that identifies which files to not build.  It
    41      # is useful for embedding static assets like code snippets and preventing
    42      # them from producing build errors for your project.
    43      nobuild_files: [path regexp for talk materials]
    44  
    45  Present then can be tested in a local App Engine environment with
    46  
    47      goapp serve
    48  
    49  Input files are named foo.extension, where "extension" defines the format of
    50  the generated output. The supported formats are:
    51  	.slide        // HTML5 slide presentation
    52  	.article      // article format, such as a blog post
    53  
    54  The present file format is documented by the present package:
    55  http://godoc.org/golang.org/x/tools/present
    56  */
    57  package main // import "golang.org/x/tools/cmd/present"