Add changes made by @dblock in #304

.github/workflows/rust.yml

@@ -1,8 +1,4 @@
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+on: [push, pull_request]
 
 env:
   CARGO_TERM_COLOR: always
@@ -44,25 +40,25 @@ jobs:
     name: Publish Check
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - uses: actions-rs/toolchain@v1
-      with:
-        toolchain: stable
-        override: true
-    - name: cargo fetch
-      uses: actions-rs/cargo@v1
-      with:
-        command: fetch
-    - name: cargo publish check lychee-lib
-      uses: actions-rs/cargo@v1
-      with:
-        command: publish
-        args: --dry-run --manifest-path lychee-lib/Cargo.toml
-    - name: cargo publish check lychee
-      uses: actions-rs/cargo@v1
-      with:
-        command: publish
-        args: --dry-run --manifest-path lychee-bin/Cargo.toml
+      - uses: actions/checkout@v1
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+      - name: cargo fetch
+        uses: actions-rs/cargo@v1
+        with:
+          command: fetch
+      - name: cargo publish check lychee-lib
+        uses: actions-rs/cargo@v1
+        with:
+          command: publish
+          args: --dry-run --manifest-path lychee-lib/Cargo.toml
+      - name: cargo publish check lychee
+        uses: actions-rs/cargo@v1
+        with:
+          command: publish
+          args: --dry-run --manifest-path lychee-bin/Cargo.toml
 
   publish:
     if: startsWith(github.ref, 'refs/tags/')

README.md

@@ -294,6 +294,14 @@ Try one of these links to get started:
 - [good first issues](https://github.com/lycheeverse/lychee/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
 - [help wanted](https://github.com/lycheeverse/lychee/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
 
+Lychee is written in Rust. Install [rust-up](https://rustup.rs/) to get started.
+Begin my making sure the following commands succeed without errors.
+
+```bash
+cargo test # runs tests
+cargo clippy # lints code
+```
+
 ## Troubleshooting and workarounds
 
 We collect a list of common workarounds for various websites in our [troubleshooting guide](./TROUBLESHOOTING.md).