Skip to content

Commit

Permalink
Files: updating README and Makefile.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nuno-Jesus committed Feb 6, 2023
1 parent ddd73fb commit 5214e02
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ PROJ = ../so_long
all: setup

setup:
echo "Checking for updates"
git pull origin main
sh tester.sh $(PROJ)

clean:
Expand Down
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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...
Expand Down

0 comments on commit 5214e02

Please sign in to comment.