From 85b1f449fac76fc82e99a821342ec9f4b34fc1a3 Mon Sep 17 00:00:00 2001
From: Mohamed Gaber <me@donn.website>
Date: Wed, 1 Sep 2021 18:43:47 +0300
Subject: [PATCH] Better Readme, Prelim. Fix for Release Detection

---
 .github/workflows/flow.yml |  3 ++-
 Readme.md                  | 30 ++++++++++++++++++++++++++++++
 Readme.txt                 |  1 -
 3 files changed, 32 insertions(+), 2 deletions(-)
 create mode 100644 Readme.md
 delete mode 100644 Readme.txt

diff --git a/.github/workflows/flow.yml b/.github/workflows/flow.yml
index 0069280..019b560 100644
--- a/.github/workflows/flow.yml
+++ b/.github/workflows/flow.yml
@@ -24,8 +24,9 @@ jobs:
         echo "TAG_NAME=$SKYWATER_COMMIT-$OPEN_PDKS_COMMIT" >> $GITHUB_ENV
     - name: Check if release exists
       run: |
+        sudo apt-get install -y jq
         echo ${{ github.token }} | gh auth login --with-token
-        gh api repos/${{ github.repository }}/releases/${{ env.TAG_NAME }} || echo "GO_AHEAD=1" >> $GITHUB_ENV
+        echo "GO_AHEAD=$(gh api repos/${{ github.repository }}/releases | jq '.[].tag_name' | grep -c ${{ env.TAG_NAME }} | tr -d '\n')" >> $GITHUB_ENV
     - name: Write PDK Root
       if: ${{ env.GO_AHEAD == '1' }}
       run: |
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..fb6cb88
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,30 @@
+# Sky130 Builder
+This repo builds sky130A using OpenLane, creates an xzipped tarball, then uploads it as a GitHub release artifact.
+
+# Requirements
+* Requires xzutils.
+* The files must be installed to `/usr/local/pdk/sky130A`.
+
+This can be done by downloading the tarball then running the following commands:
+
+```sh
+sudo mkdir -p /usr/local/pdk/sky130A
+sudo chown $USER:$USER /usr/local/pdk/sky130A
+tar -xJf ./sky130A.tar.xz -C /usr/local/pdk/sky130A
+```
+
+# License & Acknowledgements
+©2021 The American University in Cairo & The Cloud V Project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+The Sky130 PDK is owned by [these entities](https://github.com/google/skywater-pdk/blob/main/AUTHORS) and is available under the [Apache License, version 2.0](https://github.com/google/skywater-pdk/blob/main/LICENSE).
+
+
+open_pdks is ©2019-2021 R. Timothy Edwards and is available under the [Apache License, version 2.0](https://github.com/RTimothyEdwards/open_pdks/blob/master/LICENSE).
\ No newline at end of file
diff --git a/Readme.txt b/Readme.txt
deleted file mode 100644
index 668284c..0000000
--- a/Readme.txt
+++ /dev/null
@@ -1 +0,0 @@
-This repo builds sky130A using OpenLane, creates an xzipped tarball, then uploads it as a GitHub release artifact.
\ No newline at end of file