Updated readme and create release workflow

.github/workflows/create-release.yaml

@@ -76,14 +76,16 @@ jobs:
         echo "- tests/HelloWorldPublisher.sol"  >> ./build/release_note.md
         echo "- tests/HelloWorldSubscriber.sol" >> ./build/release_note.md
         echo "" >> ./build/release_note.md
-        echo "## Build configurations"                  >> ./build/release_note.md
-        echo "- OS: ${{ matrix.os }}"                   >> ./build/release_note.md
-        echo "- Node version: $(node --version)"        >> ./build/release_note.md
-        echo "- Solc version: $(solcjs --version)"      >> ./build/release_note.md
-        echo "- Optimizations: ${{ matrix.opt-flags }}" >> ./build/release_note.md
+        echo "## Build configurations"                      >> ./build/release_note.md
+        echo "- OS: \`${{ matrix.os }}\`"                   >> ./build/release_note.md
+        echo "- Node version: \`$(node --version)\`"        >> ./build/release_note.md
+        echo "- Solc version: \`$(solcjs --version)\`"      >> ./build/release_note.md
+        echo "- Optimizations: \`${{ matrix.opt-flags }}\`" >> ./build/release_note.md
         echo "" >> ./build/release_note.md
         echo "## Checksums"       >> ./build/release_note.md
+        echo "\`\`\`"             >> ./build/release_note.md
         cat ./build/checksums.txt >> ./build/release_note.md
+        echo "\`\`\`"             >> ./build/release_note.md
         echo "" >> ./build/release_note.md
 
     - name: Release

README.md

@@ -1,6 +1,21 @@
 # decent-pubsub-onchain
 Solidity code for the on-chain component of Decentagram project
 
+## Release Builds
+
+- GitHub action will automatically build releasing smart contracts on every
+  version tag
+- The latest release build can be found at [Releases](./releases)
+
+## Build Locally
+
+- Install `nodeenv` using the following command if it's not installed
+  - `python3 -m pip install nodeenv`
+  - `nodeenv` is used to create a virtual environment for `npm` packages
+- run `make` command under project's root directory, and the generated binary
+  files can be find under `build` directory
+- The `solc` compiler version can be configured in `utils/nodeenv-requirements.txt`
+
 # Ganache
 ## To start Ganache, create new keys, and add keys to keys directory:
 ```