Skip to content

Commit

Permalink
Added additional instructions and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rehno-lindeque committed Mar 2, 2011
1 parent f92979f commit 339b183
Showing 1 changed file with 55 additions and 10 deletions.
65 changes: 55 additions & 10 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,48 @@ Licensing
SceneJS-PyCollada is dual licensed under the MIT license and GPL version 2.0. Please refer to the files under licenses/ for more information.
PyCollada is licensed under a BSD-style license. Please see pycollada/COPYING for more information

Supported features
Features
========

* Loads the following geometry nodes: <polylist>, <triangles>, <lines>
** However, it is still missing the following: <polygons>
* Supports vertex splitting when a shared vertex has conflicting attributes. (This is required for flat shading or split texture coordinates for example)
* Supports the following vertex attributes:
** Positions
** Normals
** Texture coordinates (one set only at the moment)
* Loads the following light nodes: <point>,
* Generates sample files (html + javascript)

Please test and report bugs!

Work in progress
================

* Pretty printing for javascript files
* Ambient light sources (not supported by SceneJS yet)
* Point light sources (it is not known to what extent these work currently)

Installing python
=================

There's a good chance that you already have python, however if you don't, visit http://python.org and get it!

Updating pycollada
==================

* None so far!
PyCollada has been added to the project as a git submodule. To fetch the latest version of pycollada, you can use the following git command in the root directory of scenejs-pycollada.

git submodule update --init

PyCollada depends on the NumPy module. If you're on a unixy platform there's a good chance that you'll already have NumPy and you can skip this step.
If it turns out that you don't have NumPy the easiest way of installing it is with the simple command:

pip install pycollada

If you don't have 'pip' installed on your system either you can also fetch an appropriate build from the NumPy website, http://numpy.scipy.org
(See http://www.scipy.org/Download for a list of all builds including unofficial releases)


Building
========
Expand All @@ -25,12 +63,15 @@ You need to first install pycollada. Go into the directory that you've placed py

(Also see the pycollada README.markdown for more information on how to do this)

Updating pycollada
==================
Installing and running scenejs-pycollada
========================================

PyCollada has been added to the project as a git submodule. To fetch the latest version of pycollada, you can use the following git command in the root directory of scenejs-pycollada.
scenejs-pycollada is not installable currently, however you can simply run it directly.

This command will give you the usage information you need to run the utility:

python scenejs-pycollada --help

git submodule update --init

Resources
=========
Expand All @@ -43,12 +84,16 @@ Wiki page: [SceneJS Wiki page] [2]

Google group: [Google group] [3]

PyCollada home: [PyCollada] [4]
Google group "Brainstorming" discussion: [Google group discussion] [4]

PyCollada home: [PyCollada] [5]

PyCollada: [PyCollada on GitHub] [5]
PyCollada: [PyCollada on GitHub] [6]

[1]: https://github.com/xeolabs/scenejs-pycollada "GitHub project"
[2]: http://scenejs.wikispaces.com/scenejs-pycollada "SceneJS Wiki page"
[3]: http://groups.google.com/group/scenejs "Google group"
[4]: http://collada.in4lines.com/ "PyCollada"
[5]: https://github.com/pycollada/pycollada "PyCollada on GitHub"
[4]: http://groups.google.com/forum/#!topic/scenejs/jdNGC6oOA10 "New Collada translator (brainstorming)"
[5]: http://collada.in4lines.com/ "PyCollada"
[6]: https://github.com/pycollada/pycollada "PyCollada on GitHub"

0 comments on commit 339b183

Please sign in to comment.