feat: added basic index.html

daiigr · Mar 18, 2024 · 0c945ea · 0c945ea
1 parent f105eee
commit 0c945ea
Showing 1 changed file with 51 additions and 0 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,51 @@
+<!doctype html>
+<html>
+  <head>
+    <title>WindRider Project</title>
+  </head>
+  <body>
+    <h1>WindRider</h1>
+    <p>
+      WindRider is an iOS application that helps cyclists determine the best
+      time to ride based on the current and forecasted wind conditions.
+    </p>
+
+    <h2>Features</h2>
+    <ul>
+      <li>Bike Path Analysis</li>
+      <li>Weather Impact Analysis</li>
+      <li>Comfortability Score</li>
+    </ul>
+
+    <h2>Code Structure</h2>
+    <p>
+      The project consists of several Swift files. Please refer to the comments
+      in the code for more detailed explanations of each function.
+    </p>
+
+    <h2>How to Use</h2>
+    <ol>
+      <li>Create a predetermined bike path.</li>
+      <li>
+        The app will analyze the direction of the bike throughout the path.
+      </li>
+      <li>
+        It will fetch real-time weather data and calculate the amount of
+        headwind or tailwind on the path.
+      </li>
+      <li>
+        Based on the analysis, the app will provide a comfortability score and a
+        recommendation on whether it's a good day to cycle or not.
+      </li>
+    </ol>
+
+    <h2>Requirements</h2>
+    <ul>
+      <li>iOS 17.0 or later</li>
+      <li>Xcode 15.0 or later</li>
+    </ul>
+
+    <h2>License</h2>
+    <p>This project is licensed under the MIT License.</p>
+  </body>
+</html>