Skip to content

Commit

Permalink
Merge pull request #3 from cgrinker/master
Browse files Browse the repository at this point in the history
Fixing Property Mismatch for Sphere scale primative
  • Loading branch information
brochington authored Aug 26, 2016
2 parents f837bd6 + 3fe7bae commit ab8bd20
Show file tree
Hide file tree
Showing 107 changed files with 2,662 additions and 2,313 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,8 @@ Akkad

[![Join the chat at https://gitter.im/brochington/Akkad](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/brochington/Akkad?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)


`npm install --save akkad`

To get an Akkad project started quickly, check out the [Akkad boilerplate](https://github.com/brochington/akkad-boilerplate).

requires npm >= 5.0

#### Docs:

[Getting Started](https://github.com/brochington/Akkad/blob/master/docs/getting_started.md)
Expand All @@ -20,13 +15,12 @@ requires npm >= 5.0

[State tutorial](https://github.com/brochington/Akkad/blob/master/docs/tutorials/state.md)


Akkad is a React Webgl target that uses the Babylon.js library. Its aim is to allow any developer familiar with React the ability to create 3D scenes and games.

### Features

- Full power of React meets WebGL and Babylon
- Embed multiple interactive "scenes" directly in your React based site.
- Embedd multiple interactive "scenes" directly in your React based site.
- Uses a redux-like state cycle
- Defined method of extention via Entities and Systems.

Expand All @@ -39,8 +33,7 @@ Akkad is a React Webgl target that uses the Babylon.js library. Its aim is to al
- Collisions
- Particles
- Basic triggers like onClick
- Overlays with React generated DOM
- Draw textures on elements with the Canvas API.
- Add things like overlays with React generated DOM
- Lot's more to come!

## Example
Expand Down Expand Up @@ -77,17 +70,24 @@ export default App;

Please check out the example project included for more.


### Development

Akkad includes an example project for quick testing and development work. To use the example project:

From the project root:
link the akkad library in the example app. From the project root:
```
$ cd akkad
$ npm run setup:watch
$ npm link
$ cd ../example
$ npm run setup:dev // only needed the first time.
$ npm run start:dev
$ npm link akkad
$ npm start
```

In another terminal tab, navigate back to project root. Start up Akkad watch compilation:
```
$ cd akkad
$ npm run watch
```

This will allow you to make changes to Akkad live while you are running the example app.
File renamed without changes.
93 changes: 0 additions & 93 deletions akkad/README.md

This file was deleted.

Loading

0 comments on commit ab8bd20

Please sign in to comment.