forked from darwin/cmx.js
-
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
2 changed files
with
8 additions
and
57 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 |
---|---|---|
@@ -1,63 +1,14 @@ | ||
# cmx.js - a library for authoring [xkcd-style](http://xkcd.com) comixes | ||
|
||
### Please visit [cmx.io](http://cmx.io) for a live example. | ||
# This fork is working | ||
Code in [source repository](https://github.com/darwin/cmx.js) is really hard to launch, since it uses ancient technologies | ||
like bower, yeoman, ruby, grunt, coffeescript, and only works on Node 6. | ||
|
||
<a href="http://cmx.io"><img src="http://cmx.io/img/cmx-preview.png" width="800px"/></a> | ||
But... | ||
|
||
Note: Source for this comix strip is in [app/edit/sample.html](app/edit/sample.html). | ||
![wasthere.png](wasthere.png) | ||
|
||
## Development | ||
So I fixed some things and built a docker container with all of it, so you can launch it easily. | ||
Code should work as is, or you can use [docker image](docker-compose.yml). | ||
|
||
Most of the files were generated by Yeoman. Actual cmx.js sources are located in [app/lib](app/lib). | ||
|
||
#### Dependencies | ||
|
||
* [yeoman](http://yeoman.io) | ||
|
||
#### Initial setup | ||
|
||
git clone git://github.com/darwin/cmx.js.git | ||
cd cmx.js | ||
npm install | ||
bower install | ||
|
||
#### Hacking | ||
|
||
cd cmx.js | ||
grunt server | ||
=> yeoman will open browser with editor and sample.html (http://localhost:3501) | ||
|
||
#### Deploy | ||
|
||
* ruby+rake must be available | ||
* cmx.io repository checkout is expected at same directory level as cmx.js | ||
* ask for push rights to [darwin/cmx.io](https://github.com/darwin/cmx.io) or just keep forked version and let me pull your changes | ||
|
||
Initial setup: | ||
|
||
git clone git://github.com/darwin/cmx.io.git | ||
cd cmx.io | ||
git checkout gh-pages | ||
cd .. | ||
|
||
My workflow: | ||
|
||
cd cmx.js | ||
rake build | ||
cd ../cmx.io | ||
git commit -m "published a new version!" | ||
git push -u origin gh-pages | ||
|
||
=> http://cmx.io should reflect the changes in a few minutes | ||
|
||
## Acknowledgements | ||
|
||
* [Randall Munroe](http://xkcd.com) - [xkcd.com](http://xkcd.com) | ||
* [Dan Foreman-Mackey](http://dan.iel.fm) - [xkcd plot drawing](http://dan.iel.fm/xkcd) | ||
* [Jeremy Ashkenas](http://ashkenas.com) - [coffescript](http://coffeescript.org), [underscore.js](http://underscorejs.org) | ||
* [Mike Bostock](http://bost.ocks.org) - [d3.js](http://d3js.org) | ||
* [Michael Ciuffo](http://ch00ftech.com) - [humor-sans.ttf font](http://xkcdsucks.blogspot.cz/2009/03/xkcdsucks-is-proud-to-present-humor.html) | ||
* [Cloud9 guys](http://c9.io) - [Ace Editor](http://ace.ajax.org) | ||
* and many others making the web awesome | ||
|
||
## License: [MIT](license.txt) | ||
No other changes besides fixes are done - it should look exactly like many years ago. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.