Skip to content

Commit 6acde6f

Browse files
authored
Improve Markdown style
1 parent 5903eb4 commit 6acde6f

File tree

3 files changed

+17
-5
lines changed

3 files changed

+17
-5
lines changed

.github/workflows/make.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
name: Run make under CI
22

3-
on:
4-
- push
5-
- pull_request
3+
on: [push, pull_request]
64

75
jobs:
86
build:
@@ -20,5 +18,7 @@ jobs:
2018
sudo pip install mypy
2119
- name: Install shellcheck and checkbashisms
2220
run: sudo apt install shfmt shellcheck devscripts
21+
- name: Install markdownlint
22+
run: npm install markdownlint-cli2 --global
2323
- name: style check
2424
run: make style-check

Makefile

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,13 @@ ifneq ($(SH_SCRIPTS),)
4848
@${CHECKBASHISMS} -l ${SH_SCRIPTS}
4949
endif
5050

51+
style-fix: markdownlint-fix
52+
markdownlint-fix:
53+
markdownlint-cli2 --fix .
54+
style-check: markdownlint-check
55+
markdownlint-check:
56+
markdownlint-cli2 .
57+
5158
showvars:
5259
@echo "PYTHON_FILES=${PYTHON_FILES}"
5360
@echo "PYTHON_FILES_TO_CHECK=${PYTHON_FILES_TO_CHECK}"

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,23 @@ Testing](GRT_Program-Analysis-Guided_Random_Testing.pdf)"
1212
## Usage Instructions
1313

1414
### Setup
15+
1516
To set up the environment, refer to the `scripts/mutation-prerequisites.md` file.
1617

1718
### Running Scripts
19+
1820
For prerequisities, refer to `scripts/mutation-prerequisities.md`.
19-
For instructions on using the scripts, refer to `scripts/mutation-randoop.sh` for Randoop and `scripts/mutation-evosuite.sh` for EvoSuite.
21+
For instructions on using the scripts, refer to `scripts/mutation-randoop.sh`
22+
for Randoop and `scripts/mutation-evosuite.sh` for EvoSuite.
2023

2124
### Running GRT Experiments
25+
2226
See file `scripts/experiment-scripts/README.md`.
2327

2428
### Subject Programs
2529

26-
The compiled subject programs used by the GRT paper appear in the `subject-programs/` directory.
30+
The compiled subject programs used by the GRT paper appear in the
31+
`subject-programs/` directory.
2732

2833
To obtain the sources of the subject programs, see
2934
`subject-programs/README.build`.

0 commit comments

Comments
 (0)