Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mottosso committed Sep 20, 2016
1 parent 202a995 commit e678383
Showing 1 changed file with 25 additions and 14 deletions.
39 changes: 25 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
### Pyblish Starter

Jumpstart your publishing pipeline with a basic configuration.
A basic publishing pipeline, with batteries included.

> WARNING: This is in development (see latest commit date) and is NOT YET ready for an audience
> WARNING: Not ready for use.
<br>
<br>

### Prerequisities
### Description

- Maya
Build your own publishing pipeline, starting with the basics.

<br>
<br>
**Overview**

This project includes interface and implementation for 3 common types of assets a typical production pipeline.

### Limitations
- Modeling
- Rigging
- Animation

- Doesn't illustrate cross-application features of Pyblish
- Sandboxed publishing
The project illustrates how to **(1)** devise a contract - known as a `family` - for each kind of asset and **(2)** design their interface towards each other. For example, it is important for rendering and effects that the normals of each geometric surface is unlocked.

<br>
<br>
**Batteries included**

### Features
In addition to contracts, the project illustrates **boundaries** between publishing and setup. The definition of "setup" being anything that isn't strictly output, such as creating geometry or assigning attributes.

- Asset definition template
- Versioning
It includes a series of graphical user interfaces to aid the user in conforming to these contracts. These interfaces represent **placeholders** for your pipeline to fill in; you are invited to either continue from where they finish, or build your own from scratch.

<br>
<br>
Expand Down Expand Up @@ -110,6 +110,10 @@ A generic representation of geometry.

The `starter.rig` contains the necessary implementation and interface for animators to produce

![aud][] **Target Audience**

- Animation

![req][] **Requirements**

- Channels in `controls_SEL` at *default* values`*`
Expand All @@ -135,6 +139,13 @@ The `starter.rig` contains the necessary implementation and interface for animat

Point positions and normals represented as one Alembic file.

![aud][] **Target Audience**

- Lighting
- FX
- Cloth
- Hair

![req][] **Requirements**

- [No infinite velocity](#extreme-acceleration) `*`
Expand Down

0 comments on commit e678383

Please sign in to comment.