Skip to content

Commit ad47e19

Browse files
committed
[ admin ] update README-related instructions
1 parent dd6cf79 commit ad47e19

File tree

1 file changed

+8
-17
lines changed

1 file changed

+8
-17
lines changed

HACKING.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -244,23 +244,14 @@ you are never committing anything with a whitespace violation:
244244
Type-checking the README directory
245245
----------------------------------
246246

247-
* By default the README directory is not exported in the
248-
`standard-library.agda-lib` file in order to avoid clashing with other people's
249-
README files. This means that by default type-checking a file in the README
250-
directory fails.
251-
252-
* If you wish to type-check a README file, then you will need to change the line:
253-
```
254-
include: src
255-
```
256-
to
257-
```
258-
include: src .
259-
```
260-
in the `standard-library.agda-lib` file.
261-
262-
* Please do not include this change in your pull request.
263-
247+
* By default the README files are not exported in the
248+
`standard-library.agda-lib` file in order to avoid
249+
clashing with other people's README files.
250+
251+
* If you wish to type-check a README file, then you will
252+
need to change the present working directory to `doc/`
253+
where an appropriate `standard-library-doc.agda-lib`
254+
file is present.
264255

265256
Continuous Integration (CI)
266257
===========================

0 commit comments

Comments
 (0)