Add readme and update makefile

yeoji · May 9, 2020 · e83458d · e83458d
1 parent 580dfe3
commit e83458d
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/breakout/Makefile b/breakout/Makefile
@@ -11,9 +11,11 @@ build: compile-assets build_darwin_x64 build_windows_x64
 
 build_darwin_x64:
 	@GOOS=darwin GOARCH=amd64 go build -o ./build/macos-x64/$(game)
+	@cd build && zip -r $(game)-macos-x64.zip macos-x64
 
 build_windows_x64:
 	@GOOS=windows GOARCH=amd64 go build -o ./build/windows-x64/$(game).exe
+	@cd build && zip -r $(game)-windows-x64.zip windows-x64
 
 run:
 	go run *.go

diff --git a/breakout/README.md b/breakout/README.md
@@ -0,0 +1,21 @@
+## Breakout
+
+The Games50 Breakout game remade with the [Ebiten](https://github.com/hajimehoshi/ebiten) framework.
+
+### Run the Game
+
+```
+make run
+```
+
+### Play the Game
+
+**Controls**
+
+`Left|Right` - Move paddles
+
+`Space` - Pause
+
+### Assets
+
+- Games50 coursework