Adding pre-commit Github action. (#5)

.github/workflows/tests.yaml

@@ -0,0 +1,31 @@
+name: tests
+
+env:
+  GIT_MAIN_BRANCH: "main"
+
+# Controls when the workflow will run.
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+  # Allows you to run this workflow manually from the Actions tab.
+  workflow_dispatch:
+
+jobs:
+  lint_and_typecheck:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Cancel previous
+        uses: styfle/cancel-workflow-action@0.11.0
+        with:
+          access_token: ${{ github.token }}
+        if: ${{github.ref != 'refs/head/main'}}
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.8
+      - uses: pre-commit/action@v3.0.0

README.md

@@ -4,3 +4,18 @@ JAX Scaled Arithmetics is a thin library implementing numerically stable scaled
 deep neural networks in low precision (BF16, FP16, FP8).
 
 * [Draft JSA design document](docs/design.md);
+
+## Installation
+
+Local git repository install:
+```bash
+git clone git@github.com:graphcore-research/jax-scaled-arithmetics.git
+pip install -e ./
+```
+
+Running `pre-commit` and `pytest`:
+```bash
+pip install pre-commit
+pre-commit run --all-files
+pytest -v ./tests
+```