From 510ba06dee31e819e285b6e403bf8a90820ec807 Mon Sep 17 00:00:00 2001 From: KalebHawkins Date: Mon, 24 Jun 2024 20:54:30 -0500 Subject: [PATCH] add goreleaser.yaml --- .gitignore | 2 ++ .goreleaser.yaml | 46 +++++++++++++++++++++++++++++++++++ README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 111 insertions(+) create mode 100644 .gitignore create mode 100644 .goreleaser.yaml create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..cde0123 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ + +dist/ diff --git a/.goreleaser.yaml b/.goreleaser.yaml new file mode 100644 index 0000000..f0ff055 --- /dev/null +++ b/.goreleaser.yaml @@ -0,0 +1,46 @@ +# This is an example .goreleaser.yml file with some sensible defaults. +# Make sure to check the documentation at https://goreleaser.com + +# The lines below are called `modelines`. See `:help modeline` +# Feel free to remove those if you don't want/need to use them. +# yaml-language-server: $schema=https://goreleaser.com/static/schema.json +# vim: set ts=2 sw=2 tw=0 fo=cnqoj + +version: 2 + +before: + hooks: + # You may remove this if you don't use go modules. + - go mod tidy + # you may remove this if you don't need go generate + - go generate ./... + +builds: + - env: + - CGO_ENABLED=0 + goos: + - linux + - windows + - darwin + +archives: + - format: tar.gz + # this name template makes the OS and Arch compatible with the results of `uname`. + name_template: >- + {{ .ProjectName }}_ + {{- title .Os }}_ + {{- if eq .Arch "amd64" }}x86_64 + {{- else if eq .Arch "386" }}i386 + {{- else }}{{ .Arch }}{{ end }} + {{- if .Arm }}v{{ .Arm }}{{ end }} + # use zip for windows archives + format_overrides: + - goos: windows + format: zip + +changelog: + sort: asc + filters: + exclude: + - "^docs:" + - "^test:" diff --git a/README.md b/README.md new file mode 100644 index 0000000..d86c02e --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# Pong + +* Summary +* Features +* Installation +* Running the Game +* Controls +* Contributing +* License +* Project Description + +## Summary + +A Pong game written in Golang using the Ebitengine graphics library. + +## Features + +* Single player mode +* Basic graphics + +## Installation + +Make sure you have Go installed on your system. You can download it from the official [website](https://golang.org/dl/). + +Clone this repository: + +```shell +git clone https://github.com/KalebHawkins/pong.git +``` +Install dependencies: + +```shell +go mod download +``` + +## Running the Game + +Navigate to the project directory in your terminal. +Build the executable: + +```shell +go build +``` + +Run the game: + +```shell +./pong +``` + +## Controls + +**Movement:** `W` and `S` keys to move the paddle. +**Pause:** `Escape`, `Space` +**Unpause:** `Escape`, `Space` + +Contributing + +We welcome contributions to this project! If you have any bug fixes or improvements, feel free to submit a pull request. + +License + +This project is licensed under the MIT License. See the LICENSE file for details. \ No newline at end of file