-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
229 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
X3DOM has been developed by Fraunhofer IGD (VCST group). | ||
|
||
V4 nodes and features have been developed by Leonard Daly (Daly Realism) | ||
* Leonard Daly <web3d@realism.com> | ||
|
||
Contributions to core X3DOM components: | ||
* Johannes Behr | ||
* Yvonne Jung | ||
* Timo Sturm | ||
* Andreas Aderhold | ||
* Katarzyna Wilkosinska | ||
* Max Limper | ||
* Maik Thoener | ||
* Christian Stein | ||
* Tobias Franke | ||
* Peter Eschler | ||
* Timm Drevensek | ||
|
||
Contributions to shadow mapping: | ||
* Nicolas Eicke | ||
|
||
Contributions to BVHRefiner component: | ||
* Michael Englert | ||
|
||
Contributions to the CAD component: | ||
* Don Brutzman <brutzman@nps.edu> | ||
* Vincent Marchetti <vmarchetti@ameritech.net> | ||
* "이효광 (Hyokwang Lee)" <adpc92@gmail.com> | ||
* Joe D Williams <joedwil@earthlink.net> | ||
|
||
Contributions to the Geo component: | ||
* "Byounghyun Yoo (유병현)" <yoo@byoo.net> | ||
* Andreas Plesch <andreasplesch@gmail.com> | ||
|
||
Other much-appreciated contributors: | ||
* x3domer | ||
* James Sweet | ||
* John Congote | ||
* Ander Arbelaiz <aarbelaiz@vicomtech.org> | ||
* Yurai Núñez-Rodríguez <yurai@weblakes.com> | ||
* ... | ||
* Your Name <couldbe@here.com> | ||
|
||
A big thank you to Philip Taylor. X3DOM is originally based on his first prototypical implementation of a scene graph in HTML 5. http://philip.html5.org |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
Dual licensed under the MIT and GPL licenses. | ||
|
||
==[MIT]==================================================================== | ||
Copyright (c) 2009 X3DOMV4 | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. | ||
|
||
|
||
==[GPL]==================================================================== | ||
|
||
X3DOM - Declarative 3D for HTML | ||
|
||
Copyright (C) 2009 X3DOMV4 | ||
|
||
This program is free software: you can redistribute it and/or modify | ||
it under the terms of the GNU General Public License as published by | ||
the Free Software Foundation, either version 3 of the License, or | ||
(at your option) any later version. | ||
|
||
This program is distributed in the hope that it will be useful, | ||
but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
GNU General Public License for more details. | ||
|
||
You should have received a copy of the GNU General Public License | ||
along with this program. If not, see <http://www.gnu.org/licenses/>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,133 @@ | ||
Welcome to X3DOM | ||
================ | ||
X3DOM is a framework for integrating and manipulating (X)3D scenes as HTML5 | ||
DOM elements, which are rendered via an X3D plugin, Flash/Stage3D or WebGL. | ||
The open-source system allows defining 3D scene description and runtime | ||
behavior declaratively, without any low-level JavaScript or GLSL coding. | ||
|
||
This addition is a testbed platform for X3D V4 nodes. It is developed as | ||
an addition to X3DOM | ||
|
||
This library should be included after all standard X3DOM libraries. | ||
|
||
What follows below is the documentation for X3DOM V1.7.1 | ||
|
||
Getting started | ||
--------------- | ||
Please have a look at the official documentation in order to get started: | ||
|
||
http://doc.x3dom.org | ||
|
||
|
||
Need help? | ||
---------- | ||
If you want to use X3DOM and seek help and exchange of knowledge, please use | ||
the x3dom-users mailing list or the forums. Beginner questions usually have | ||
been asked already and in many cases the mailinglist or forum archives provide | ||
quick answers to many questions. | ||
|
||
If you decide to post to the mailing list or forum, please include as much | ||
info as possible and describe your problem and what you tried already | ||
succinctly. | ||
|
||
|
||
Mailing List | ||
------------- | ||
Please use the mailinglists as much as you can. The | ||
[x3dom-users][] list is the one you are most likely interested in | ||
and the first address for help or questions. | ||
|
||
Questions specifically about V4 nodes and features should be directed | ||
to the x3d-public@web3d.org mailing list. | ||
|
||
|
||
Issue Tracker | ||
------------- | ||
Please report issues and attach patches here. For general help and questions | ||
direct your inquiry to the x3dom-users mailing list or one of the forums. | ||
|
||
https://github.com/x3dom/x3dom/issues | ||
|
||
|
||
**Uploading Files to the Issue Tracker** | ||
The GitHub issue tracker does not allow to upload files. However, there is a | ||
service that helps you with sharing files: https://gist.github.com. Just copy | ||
and paste your file contents there and then copy the Gist URL into the | ||
issues form. | ||
|
||
It immensely helps us if you can provide a live web page illustrating your | ||
problem. So if you have webspace and can upload and post the URL with your | ||
issue, the chances we will have a look at it increase. | ||
|
||
|
||
Contributing | ||
------------ | ||
We encourage you to contribute to X3DOM! If you would like to contribute to | ||
X3DOM, you should subscribe to the developers mailing list ([x3dom-dev][]), | ||
where the developers of X3DOM discuss the development of the library itself. | ||
|
||
You can send pull requests via GitHub. Patches should: | ||
|
||
1. Follow the style of the existing code. | ||
2. One commit should do exactly one thing. | ||
3. Commit messages should start with a summary line below 80 characters | ||
followed by a blank line, and then the reasoning/analysis for why the | ||
change was made (if appropriate). | ||
4. Commits that fix a bug in a previous commit (which has already been | ||
merged) should start with `fixup!` and then the summary line of the | ||
commit it fixes. | ||
5. Rebase your branch against the upstream’s master. We don’t want to pull | ||
redundant merge commits. | ||
6. **Be clear about what license applies to your patch:** The files within | ||
this repository are under the GPL3 (or later) but, as the original | ||
creators, we are still allowed to create non-free derivatives. However, | ||
if patches are given to us under GPL then those cannot make it into any | ||
non-free derivatives we may later wish to create. So to make it easier | ||
for us (and avoid any legal issues) we prefer if patches are released as | ||
public domain. | ||
|
||
|
||
### GitHub Workflow | ||
|
||
Developing patches should follow this workflow: | ||
|
||
1. Fork on GitHub (click Fork button) | ||
2. Clone to computer: `git clone git@github.com:«github account»/x3dom.git` | ||
3. cd into your repo: `cd x3dom` | ||
4. Set up remote upstream: `git remote add -f upstream git://github.com/x3dom/x3dom.git` | ||
5. Create a branch for the new feature: `git checkout -b my_new_feature` | ||
6. Work on your feature, add and commit as usual | ||
|
||
Creating a branch is not strictly necessary, but it makes it easy to delete | ||
your branch when the feature has been merged into upstream, diff your branch | ||
with the version that actually ended in upstream, and to submit pull requests | ||
for multiple features (branches). | ||
|
||
7. Push branch to GitHub: `git push origin my_new_feature` | ||
8. Issue pull request: Click Pull Request button on GitHub | ||
|
||
#### Useful Commands | ||
|
||
If a lot of changes have happened upstream you can replay your local changes | ||
on top of these, this is done with `rebase`, e.g.: | ||
|
||
git fetch upstream | ||
git rebase upstream/master | ||
|
||
This will fetch changes and re-apply your commits on top of these. | ||
|
||
This is generally better than merge, as it will give a clear picture of which | ||
commits are local to your branch. It will also “prune” any of your local | ||
commits if the same changes have been applied upstream. | ||
|
||
You can use `-i` with `rebase` for an “interactive” rebase. This allows you | ||
to drop, re-arrange, merge, and reword commits, e.g.: | ||
|
||
git rebase -i upstream/master | ||
|
||
There's always the [x3dom-dev][] mailinglist. | ||
|
||
|
||
[x3dom-users]: https://lists.sourceforge.net/lists/listinfo/x3dom-users | ||
[x3dom-dev]: https://lists.sourceforge.net/lists/listinfo/x3dom-developers | ||
[GPL 3]: http://www.gnu.org/copyleft/gpl.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
.. _releasenotes: | ||
|
||
Release notes | ||
============= | ||
|
||
Version 0.01 | ||
------------- | ||
|
||
* Initial release | ||
* Created new nodes Animate and Interpolate. Nodes still being developed. |