Merge branch 'master' into strymonas-v2

Author: biboudis

.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+on:
+  pull_request:
+  push:
+jobs:
+  build-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        java: [ 8, 11 ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup JDK
+        uses: actions/setup-java@v2
+        with:
+          java-version: ${{ matrix.java }}
+          distribution: 'adopt'
+      - name: Install sbt
+        run: curl -Ls https://git.io/sbt > ./sbt && chmod 0755 ./sbt
+      - name: Prepare cache
+        uses: coursier/cache-action@v6
+      - name: Test
+        run: ./sbt test

README.md

@@ -1,4 +1,24 @@
-This is a private mirror of the strymonas/strymonas on github to track the Scala 3 port properly. Will help us iterate on version 2 of strymonas and push to upstream.
+**strymonas** is a library providing fast-streams for Scala 3/dotty through multi-stage programming and partial evaluation.
 
+![ci](https://github.com/strymonas/strymonas/actions/workflows/ci.yml/badge.svg)
+[![Join the chat at https://gitter.im/strymonas/strymonas](https://badges.gitter.im/strymonas/strymonas.svg)](https://gitter.im/strymonas/strymonas?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
+## Building strymonas
 
+strymonas is built with SBT 1.3.8 or later and uses the [sbt-dotty](https://github.com/lampepfl/dotty/tree/master/sbt-dotty) plugin for Scala 3.
+
+* Use `sbt test` to run the tests.
+* Use `sbt bench/jmh:run` to run the benchmarks
+
+## Contributors
+
+* Oleg Kiselyov ([okmij.org](http://okmij.org/ftp/))
+* Aggelos Biboudis ([@biboudis](https://github.com/biboudis))
+* Nick Palladinos ([@palladin](https://github.com/palladin))
+* Yannis Smaragdakis ([yanniss](https://yanniss.github.io/))
+* Nicolas Stucki ([@nicolasstucki](https://github.com/nicolasstucki))
+* Tomoaki Kobayashi ([@moatom](https://github.com/moatom))
+
+## Credits
+
+Strymonas has its origins in a [paper](https://dl.acm.org/doi/10.1145/3093333.3009880) published by Oleg Kiselyov ([okmij.org](http://okmij.org/ftp/)), Aggelos Biboudis ([@biboudis](https://github.com/biboudis)), Nick Palladinos ([@palladin](https://github.com/palladin)) and Yannis Smaragdakis [site](https://yanniss.github.io/) and this repo has its aim into making this library available for Scala 3. The initial prototypes (that correspond directly to the paper, were developed for [Scala/LMS](https://github.com/strymonas/staged-streams.scala) and [OCaml/BER MetaOCaml](https://github.com/strymonas/staged-streams.ocaml)) and the initial commit for the Scala 3 port is based on the case study presented for the [paper](https://biboudis.github.io/papers/pcp-gpce18.pdf) published by Nicolas Stucki [@nicolasstucki](https://github.com/nicolasstucki).