<p>This is a basic battleship game created as our submission for project 1 for EECS 448 at the University of Kansas.</p>
<h2>Structure Info</h2>
<p>This project has been wired up to use Vue.js to help organize components of the game.</p>
<p>These components are defined in files that end in the <code>.component.js</code> extension, and are located in the <code>src/components/</code> directory.</p>
<p>The entry point for the project is the <code>index.html</code>. This file contains the basic logic for loading Vue, and adding the game board to the page.</p>
<p>Obviously, we'll flesh out the look-and-feel as we go along. This is just a basic starter for now.</p>
<h2>How to Run</h2>
<p>The easiest way to run this project is by creating a basic static web server using Python. This is super simple:</p>
<ol>
<li>Open a terminal or command prompt to the root of this project (i.e. the directory this file is in).</li>
<li>Start the server: <code>python -m http.server</code></li>
</ol>
<p>This will start a web server on port 8000. You can then run the game by navigating to http://localhost:8000/ from a web browser.</p>
<h2>Documentation</h2>
<p>You can <ahref="https://htmlpreview.github.io/?https://raw.githubusercontent.com/EECS-448-Battleship/project-1/master/documentation/generated/index.html">preview it here</a>. Otherwise, it is generated by JSDoc in the <code>documentation/generated</code> directory.</p>
<h3>Re-generating the documentation</h3>
<p>To regenerate the docs, you need Node.js and the Yarn package manager installed. Then, just:</p>