tilera/jocly
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

removed README from index

Browse source
This commit is contained in:
mig 2017-04-07 01:30:43 +02:00
parent 59a44117c1
commit 95c40f1edf
1 changed files with 0 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
README.md
View file

@ -1,51 +0,0 @@
**Warning: This is work in progress**
Jocly is a library and set of tools to integrate boards games into Web environments.
It comes with a large collection of abstract strategy games, 2D and 3D user interface,
artificial intelligence to play against.
Demos
-----
[Controlled interface](https://mi-g.github.io/jocly/examples/browser/control.html) for playing Chess.
Click _**Other Jocly games**_ to switch to other games.
Simple human vs computer: [Classic chess](https://mi-g.github.com/jocly/examples/browser/simple.html?classic-chess),
[Circular chess](https://mi-g.github.com/jocly/examples/browser/simple.html?circular-chess),
[Multi layers chess](https://mi-g.github.com/jocly/examples/browser/simple.html?raumschach),
[Hexagonal chess](https://mi-g.github.com/jocly/examples/browser/simple.html?glinski-chess),
[Chinese chess](https://mi-g.github.com/jocly/examples/browser/simple.html?xiangqi),
[Middle-age chess](https://mi-g.github.com/jocly/examples/browser/simple.html?courier-chess),
[Scrum](https://mi-g.github.com/jocly/examples/browser/simple.html?scrum)
Or see and try [all available games](https://mi-g.github.com/jocly/examples/browser/multiple.html)
Building
--------
- install the *node.js* environment (using [nvm](https://github.com/creationix/nvm) is probably a good idea)
- install *gulp*: `nvm install -g gulp`
- install [git](https://git-scm.com/downloads)
- clone Jocly from *github*: `git clone https://github.com/mi-g/jocly.git`
- enter the `jocly` directory
- build: `gulp build`
- `dist/browser` contains the javascript library to build web applications, `dist/node` is the module to be used for node.js applications
Using Jocly in a Web page
-------------------------
After building Jocly, copy the `dist/browser` directory as `jocly` into your project filesystem.
Insert this line to your HTML source code:
````
<script src="jocly/jocly.js"></script>
````
You are now ready to use the Jocly API through the `Jocly` global object.
API Documentation
-----------------
This section is to be written. For now, check the examples into the `examples/browser`
and `examples/node` sub-directories.