README.md

CPPND: Capstone Snake Game Example

This is a starter repo for the Capstone project in the Udacity C++ Nanodegree Program. The code for this repo was inspired by this excellent StackOverflow post and set of responses.

The Capstone Project gives you a chance to integrate what you've learned throughout this program. This project will become an important part of your portfolio to share with current and future colleagues and employers.

In this project, you can build your own C++ application or extend this Snake game, following the principles you have learned throughout this Nanodegree Program. This project will demonstrate that you can independently create applications using a wide range of C++ features.

Dependencies for Running Locally

• cmake >= 3.7
  • All OSes: click here for installation instructions
• make >= 4.1 (Linux, Mac), 3.81 (Windows)
  • Linux: make is installed by default on most Linux distros
  • Mac: install Xcode command line tools to get make
  • Windows: Click here for installation instructions
• SDL2 >= 2.0
  • All installation instructions can be found here
  • Note that for Linux, an apt or apt-get installation is preferred to building from source.
• gcc/g++ >= 5.4
  • Linux: gcc / g++ is installed by default on most Linux distros
  • Mac: same deal as make - install Xcode command line tools
  • Windows: recommend using MinGW

Basic Build Instructions

1. Clone this repo.
2. Make a build directory in the top level directory: mkdir build && cd build
3. Compile: cmake .. && make
4. Run it: ./SnakeGame.

Adressed rubric points

1. Concurrency - The project uses multithreading. (renderer.cpp l.51-57)
2. Concurrency - A mutex or lock is used in the project (render.h l.32, renderer.cpp l. 72 & 85 & 114)
3. Loops, Functions, I/O - The project accepts user input and processes the input (main.cpp l.16-18, renderer.cpp l.64)
4. Loops, Functions, I/O - The project reads data from a file and process the data, or the the program writes data to a file. (main.cpp l.28-31)
5. Loops, Functions, I/O - The project demonstrates an understanding of C++ functions and control structures.
6. Object Oriented Programming - The project uses object oriented programming techniques. (classes: obstacle.h, snake.h, game.h, renderer.h)
7. Object Oriented Programming - Classes use appropriate access specifiers for class members.
8. Object Oriented Programming - Class constructors utilize member initialization lists.