diff --git a/.github/README.md b/.github/README.md index 180d4c72bf..f6fada1acd 100644 --- a/.github/README.md +++ b/.github/README.md @@ -28,9 +28,9 @@ Build scripts for GitHub actions are always stored in the [workflows](./workflow ## Build locally -The [examples](./examples) directory contains scripts to show how to build R locally. Basically these scripts just let you run the same steps as the CI in [build-svn.yaml](./workflows/build-svn.yaml) for a given platform: +The [examples](./examples) directory contains scripts to show how to build R locally. Basically these scripts just let you run the same steps as the CI in [`build-svn.yaml`](./workflows/build-svn.yaml) for a given platform: - - [build-r-macos.sh](./examples/build-r-macos.sh): do a full prep, build, and check on MacOS. + - [`build-r-macos.sh`](./examples/build-r-macos.sh): do a full prep, build, and check on MacOS. ## Develop locally @@ -40,9 +40,9 @@ A default clone will have the following two problems: - A large amount of untracked unignored files. - A change in `Makefile.in` necessitated by having to build from a Git clone. -The [local](./local) directory contains files to help with these issues: +The [`local`](./local) directory contains files to help with these issues: -- [dot-gitignore](./local/dot-gitignore): A `.gitignore` file ready to copy to the root of the project. -- [post-checkout](./local/post-checkout): A script to update the `SVNINFO` file after each checkout or commit. +- [`dot-gitignore`](./local/dot-gitignore): A `.gitignore` file ready to copy to the root of the project. +- [`post-checkout`](./local/post-checkout): A script to update the `SVNINFO` file after each checkout or commit. -Run the [setup.sh](./local/setup.sh) script for automated setup. +Run the [`setup.sh`](./local/setup.sh) script for automated setup.