@1pizzateam/roostr 0.0.0-stage → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +35 -2
- package/dist/roostr.d.ts +941 -0
- package/dist/roostr.js +3650 -0
- package/package.json +65 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2015 Ludovic CLUBER
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,36 @@
|
|
|
1
|
-
|
|
1
|
+
[](https://opensource.org/licenses/MIT)
|
|
2
|
+
[](https://www.npmjs.com/package/@1pizzateam/roostr)
|
|
3
|
+
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
## Synopsis
|
|
6
|
+
|
|
7
|
+
[RoostR.js](https://github.com/1pizzateam/RoostR.js) is an open source WebGL 3D engine written in TypeScript to help you develop HTML5 / WebGL applications for desktop and mobile browsers.
|
|
8
|
+
|
|
9
|
+
## Motivation
|
|
10
|
+
|
|
11
|
+
The main purpose of this library is to provide a simple, modular way to develop 3D applications for browsers.
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
$ npm install @1pizzateam/roostr
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Documentation
|
|
20
|
+
|
|
21
|
+
The documentation website is at **[https://1pizzateam.github.io/RoostR.js/](https://1pizzateam.github.io/RoostR.js/)**.
|
|
22
|
+
|
|
23
|
+
## Contributors
|
|
24
|
+
|
|
25
|
+
There is still a lot of work to do on this project and I would be glad to get all the help you can provide.
|
|
26
|
+
To contribute you can clone the project on **[GitHub](https://github.com/1pizzateam/RoostR.js)** and see **[contributor.md](contributor.md)** for detailed installation walkthrough of the project.
|
|
27
|
+
|
|
28
|
+
## Stack
|
|
29
|
+
|
|
30
|
+
| Purpose | Choice | Motivation |
|
|
31
|
+
| :-------------- | :------------------------------------------: | -------------------------------------------------------------: |
|
|
32
|
+
| repository | [Github](https://github.com/) | hosting for software development version control using Git |
|
|
33
|
+
| package manager | [npm](https://www.npmjs.com/get-npm) | default node.js package manager |
|
|
34
|
+
| language | [TypeScript](https://www.typescriptlang.org) | static type checking along with the latest ECMAScript features |
|
|
35
|
+
| module bundler | [Rollup](https://rollupjs.org) | advanced module bundler for ES6 modules |
|
|
36
|
+
| unit testing | [Jest](https://jestjs.io/) | delightful testing with a focus on simplicity |
|