From 0f79aaa3114cc3d8cc1fcbad6a256e5a46d5e910 Mon Sep 17 00:00:00 2001
From: thornySoap <115401023+thornySoap@users.noreply.github.com>
Date: Sat, 25 Mar 2023 21:53:07 +0100
Subject: [PATCH] Create README.md

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..514eb95
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# pysnakexia8
+Snake suitable for running with Pygame or on TI-Nspire's Python platform.
+
+<table>
+<tr>
+<td width=46%>
+
+![20230325_214107](https://user-images.githubusercontent.com/115401023/227740926-f61f0822-10c9-4595-a2fa-e4e83d4c9f58.jpg)
+
+</td>
+<td>
+
+![Screenshot 2023-03-25 21:46:28](https://user-images.githubusercontent.com/115401023/227740930-d74b4246-9300-4581-a04c-2c60ffeb227f.png)
+
+</td>
+</tr>
+</table>
+
+
+## run
+
+### Pygame (Desktop)
+1. Have [Pygame](https://www.pygame.org/wiki/GettingStarted#Pygame%20Installation) installed
+2. run:
+```bash
+cd src/main
+python main.py  # or "python3 main.py"
+```
+
+### TI-Nspire
+1. Download .tns-file from [releases](https://github.com/thornySoap/pysnakexia8/releases/tag/release)
+2. Use https://nspireconnect.ti.com/ (only Chromium based browsers) to transfer the file to your calculator (Linux-users: [Chrome USB udev](https://developer.chrome.com/docs/apps/app_usb/#caveats))
+3. Open it. On the first page (`main.py`) press `Ctrl+R` to run
+
+## "build"
+Use TI-Nspire Student Software and copy-paste the code of `src/main/main.py` and `src/pygame/pygame.py` into two pages (`main.py` and `pygame.py`) in one document.
+
+## License
+[MIT-License](https://github.com/thornySoap/pysnakexia8/blob/master/LICENSE)