Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
clean up text a bit.  Add live-editing gif.
  • Loading branch information
NHDaly committed Apr 16, 2018
1 parent e70d650 commit af1faaf
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Paddle Battle -- a simple game written in Julia.

A simple pong-clone built in [`julia`](https://github.com/JuliaLang/julia) using
A simple pong clone built in [`julia`](https://github.com/JuliaLang/julia) using
the [`SDL2`](https://www.libsdl.org/) library.

This repo is an example of building a complete game, distributed as a `.app`,
written entirely in Julia! This game uses the
This repo is an example of building a complete game, compiled and distributed as
a `.app`, written entirely in Julia! This game uses the
[`SDL2.jl`](https://github.com/jonathanBieler/SDL2.jl) package, which provides
julia bindings for `SDL2`, for its graphics and keyboard/mouse input.

Expand All @@ -13,13 +13,16 @@ the build script (`./build.sh`). It simply invokes `build_app.jl` from
[NHDaly/build-jl-app-bundle](https://github.com/NHDaly/build-jl-app-bundle) to
compile and bundle a macOS application from the julia code.

# Install
Building the game in Julia was lots of fun! Not least, live-editing code in Juno is
really nice:
![Paddle-Battle-Juno-live-editing.gif](http://nhdalymadethis.website/assets/images/Paddle-Battle-Juno-live-editing.gif)

You can download a complete build for Mac here:
https://nhdaly.github.io/assets/PaddleBattle.dmg
## Install

You can download the game for Mac here:
https://nhdalyMadeThis.website

# License
## License
This project is licensed under the terms of the MIT license.

Please do go ahead and copy it, modify it, remix it, and sell your creation!

0 comments on commit af1faaf

Please sign in to comment.