Revamp documentation resources (#54)

* Move Bartosz's report to its own directory * Move Martin Odersky's talk and README to docs * Add Maximilian's report * Add landing page * Add a simple README
lampepfl · Mar 21, 2024 · 7c033a3 · 7c033a3
1 parent cf269c8
commit 7c033a3
Show file tree

Hide file tree

Showing 14 changed files with 668 additions and 518 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,3 +11,15 @@ All of the needed dependencies can be loaded by the included Nix Flake. If you h
 nix develop
 ```
 to enter the development environment with all the dependencies loaded. You can also use [direnv](https://direnv.net/)'s `use flake` to automate this process.
+
+Once done, it should suffice to run
+```bash
+sbt publishLocal
+```
+to have Gears compiled and published locally for usage.
+
+## Running Tests
+
+```bash
+sbt test
+```
diff --git a/README.md b/README.md
diff --git a/docs/2023-02-scalar-talk/README.md b/docs/2023-02-scalar-talk/README.md
diff --git a/scalar-slides.pdf → docs/2023-02-scalar-talk/scalar-slides.pdf b/scalar-slides.pdf → docs/2023-02-scalar-talk/scalar-slides.pdf
diff --git a/scalar.pdf → docs/2023-02-scalar-talk/scalar.pdf b/scalar.pdf → docs/2023-02-scalar-talk/scalar.pdf
diff --git a/docs/ch1.png → docs/2023-06-report/ch1.png b/docs/ch1.png → docs/2023-06-report/ch1.png
diff --git a/docs/ch2.png → docs/2023-06-report/ch2.png b/docs/ch2.png → docs/2023-06-report/ch2.png
diff --git a/docs/ch3.png → docs/2023-06-report/ch3.png b/docs/ch3.png → docs/2023-06-report/ch3.png
diff --git a/docs/ch4.png → docs/2023-06-report/ch4.png b/docs/ch4.png → docs/2023-06-report/ch4.png
diff --git a/docs/ch5.png → docs/2023-06-report/ch5.png b/docs/ch5.png → docs/2023-06-report/ch5.png
diff --git a/docs/summary-2023-06.md → docs/2023-06-report/summary-2023-06.md b/docs/summary-2023-06.md → docs/2023-06-report/summary-2023-06.md
diff --git a/docs/summary-2023-06.pdf → docs/2023-06-report/summary-2023-06.pdf b/docs/summary-2023-06.pdf → docs/2023-06-report/summary-2023-06.pdf
diff --git a/docs/2024-01-report.pdf b/docs/2024-01-report.pdf
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,99 @@
+<!DOCTYPE html>
+<head>
+  <title>
+    Gears - An Experimental Asynchronous Programming Library for Scala 3
+  </title>
+  <link
+    rel="stylesheet"
+    href="https://cdn.jsdelivr.net/npm/@picocss/pico@2/css/pico.red.min.css"
+  />
+</head>
+<body class="container">
+  <style>
+    main {
+      display: grid;
+      grid-template-columns: 4fr 1fr;
+      grid-template-rows: 1fr;
+      grid-column-gap: 0px;
+      grid-row-gap: 0px;
+    }
+  </style>
+  <header>
+    <hgroup>
+      <h1>Gears</h1>
+      <p>An Experimental Asynchronous Programming Library for Scala 3</p>
+    </hgroup>
+  </header>
+  <main>
+    <div>
+      <section>
+        <h2>Getting Started</h2>
+        <ul>
+          <li>
+            <a href="https://github.com/lampepfl/gears/releases"
+              >Releases</a
+            >
+          </li>
+          <li>
+            <a
+              href="https://github.com/lampepfl/gears/blob/main/CONTRIBUTING.md"
+              >Build Instructions</a
+            >
+          </li>
+        </ul>
+      </section>
+      <section>
+        <h2>Documentation</h2>
+        <ul>
+          <li>
+            <a href="https://blog.nkagami.me/gears-book" target="_blank">
+              <em>Concurrency with Gears</em>, a tutorial-documentation on using Gears
+            </a>
+          </li>
+          <li>
+            <a href="./api">API Documentation</a>
+          </li>
+          <li>
+            <a href="https://github.com/lampepfl/gears">GitHub Repository</a>
+          </li>
+        </ul>
+      </section>
+      <section>
+        <h2>References</h2>
+        <ul>
+          <li>
+            <em>Martin Odersky</em> - Direct Style Scala (02/2023):
+            <a href="https://www.youtube.com/watch?v=0Fm0y4K4YO8">Talk</a>
+            <a href="./2023-02-scalar-talk/scalar-slides.pdf">Slides</a>
+            <a
+              href="https://github.com/lampepfl/gears/blob/main/docs/2023-02-scalar-talk/README.md"
+              >Markdown</a
+            >
+          </li>
+          <li>
+            <em>Bartosz Białas</em> - Gears Project Report (Features and
+            Performance on Loom) (06/2023):
+            <a href="./2023-06-report/summary-2023-06.pdf">PDF</a>
+            <a
+              href="https://github.com/lampepfl/gears/blob/main/docs/2023-06-report/summary-2023-06.md"
+              >Markdown</a
+            >
+          </li>
+          <li>
+            <em>Maximilian Müller</em> - Project Report: Cross-platform Gears
+            (01/2024):
+            <a href="./2024-01-report.pdf">PDF</a>
+          </li>
+        </ul>
+      </section>
+    </div>
+    <img
+      src="https://www.scala-lang.org/resources/img/frontpage/scala-spiral.png"
+      style="text-align: center; width: 80%"
+    />
+  </main>
+  <footer>
+    The Scala Logo belongs to the
+    <a href="https://scala-lang.org">Scala Programming Language</a>.
+  </footer>
+</body>