reame run and workflow

.github/workflows/release.yml

@@ -32,15 +32,15 @@ jobs:
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 
-      # - name: Build and push Docker image
-      #   uses: docker/build-push-action@v4
-      #   with:
-      #     context: .
-      #     push: true
-      #     tags: ${{ steps.meta.outputs.tags }}
-      #     labels: ${{ steps.meta.outputs.labels }}
-      #     cache-from: type=gha
-      #     cache-to: type=gha,mode=max
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
 
       - name: Run Container and Generate PDF
         run: docker run -v ${{ github.workspace }}/output:/data/output ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.ref_name }}

README.md

@@ -1,2 +1,15 @@
 # NSPYC
-This is a readme
+This is the source repo of **NSPYC** (Non-Standard Polish Yellow Card), a SAYC based bridge bidding convention. The convention is written in polish.
+
+## PDF
+The PDF is accesible on the [releases](https://github.com/ThePinion/nspyc/releases) page. The latest as well as old versions might be downloaded from there.
+
+## Local build
+The PDF's are built automatically using github-actions. If you want to build the PDF yourself clone the repo or download the source code, and build and run the docker image using:
+```bash
+run.sh
+``` 
+Note that you have to have the [Docker](https://www.docker.com/) installed.
+
+### Contributing
+If you want to contribute to the convention, edit the `convention.md`. After you verify the built PDF locally, submit a Pull Request. Please follow the styling convention. 

run.sh

@@ -1 +1,4 @@
+docker build -t nspyc-pandoc .
+echo "Building the PDF..."
 docker run --rm -v "`pwd`:/data/output" nspyc-pandoc
+echo "Done!"