From 315a6d271d2af5b43083448a62f079033be95938 Mon Sep 17 00:00:00 2001 From: Jan Sierpina Date: Fri, 1 Aug 2025 13:39:28 +0200 Subject: [PATCH 1/2] Added license, readme, contributing guidelines --- CONTRIBUTING.md | 12 ++++++++++++ LICENSE.md | 22 ++++++++++++++++++++++ README.md | 28 ++++++++++++++++++++++++++++ 3 files changed, 62 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f306c36 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,12 @@ +# Contributing to papergo + +Thanks for helping! Here's how to contribute: + +- Fork the repo. +- Create a branch for your feature or fix. +- Make your changes and commit with a clear message. +- Open a pull request. Short and simple is fine. +- Be nice and respectful. + +That's it! + diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..35c56c0 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,22 @@ +MIT License + +Copyright (c) 2025 Papergo + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..a132d7a --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# papergo + +A terminal-based game written in Go, inspired by the classic paper-and-pencil style. +Multiplayer support and simple CLI interface. Open source and open to contributions. + +## 🔧 How to run + +1. Clone the repo: + + ```bash + git clone https://github.com/yourname/papergo.git + cd papergo + ``` + +2. Build and run: + +```bash + go run . +``` + + +3. Or build a binary: + +```bash + go build -o papergo + ./papergo +``` + From 4f22079c76fd84ac4082596465e5aa06b796b4c9 Mon Sep 17 00:00:00 2001 From: Jan Sierpina Date: Fri, 1 Aug 2025 13:44:31 +0200 Subject: [PATCH 2/2] Readme update --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a132d7a..9192980 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # papergo -A terminal-based game written in Go, inspired by the classic paper-and-pencil style. +A terminal-based game written in Go, inspired by the classic paper.io game. Multiplayer support and simple CLI interface. Open source and open to contributions. ## 🔧 How to run @@ -8,7 +8,7 @@ Multiplayer support and simple CLI interface. Open source and open to contributi 1. Clone the repo: ```bash - git clone https://github.com/yourname/papergo.git + git clone https://github.com/jsierp/papergo.git cd papergo ```