From 5214e02fed4695546aa39712f2d7446d3bb3cb30 Mon Sep 17 00:00:00 2001 From: Nuno Jesus Date: Mon, 6 Feb 2023 16:13:33 +0000 Subject: [PATCH] Files: updating README and Makefile. --- Makefile | 2 ++ README.md | 13 ++++++++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index b2bd482..4a507c6 100644 --- a/Makefile +++ b/Makefile @@ -22,6 +22,8 @@ PROJ = ../so_long all: setup setup: + echo "Checking for updates" + git pull origin main sh tester.sh $(PROJ) clean: diff --git a/README.md b/README.md index 225da2a..c4cd80f 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,18 @@ In order to correctly execute the tool, you must: - have either [Ubuntu](https://ubuntu.com/download) or [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) on your computer; - install [pip](https://linuxize.com/post/how-to-install-pip-on-ubuntu-20.04/) **ONLY IF** there is a missing package that you might need to install manually (text me, otherwise I won't know); -## Great, I managed to do it! What's next? +## Repository contents + +|Folder/File|Description| +|:--:|:--:| +|maps/valid/| Maps that your project should accept | +|maps/invalid/| Maps that your project should not accept (used by the py script) | +|maps/generated/| Generated maps after running the python script | +|generator.py| The python script to automate maps generation | +|tester.sh| The shell script used to fetch the output from your project | + + +## Next steps **1.** Fork/download the code from the repository to any path of your choice in your computer (the best would be to sit right next to your **so_long** folder, like described below) **2.** If your directory tree looks like this...