Skip to content

Commit 081789d

Browse files
authored
Merge pull request #11 from handrews/naming
Update README for naming vs the build system
2 parents e52de4f + ca27d96 commit 081789d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,13 @@ Due to the focus on interoperability, the initial assumption is to produce IETF
3939

4040
## Format
4141

42-
Proposals should be written in Markdown and submitted as PRs from a fork of the repo, and named in RFC I-D `draft-{primary-editor}-{draft-name}.md` style. For example, if JSON Schema Validation were written in this format, the file name would be `draft-bhutton-json-schema-validation.md`.
42+
Proposals should be written in Markdown and submitted as PRs from a fork of the repo.
4343

44-
Plain markdown is welcome. The repository will also automatically build [kramdown-rfc](https://github.com/cabo/kramdown-rfc) format documents, which can use the [markdown I-D template](https://github.com/martinthomson/i-d-template) as a starting point.
44+
The repository will automatically build [kramdown-rfc](https://github.com/cabo/kramdown-rfc) format documents, which should be named in RFC I-D `draft-{primary-editor}-{draft-name}.md` style. For example, if JSON Schema Validation were written in this format, the file name would be `draft-bhutton-json-schema-validation.md`.
4545

46-
You will need a reasonably recent version of Python 3 to run a local build, but the makefile will check out everything else it needs using a submodule and automatically create a virtual env for the build.
46+
Plain markdown is also welcome, and such proposals should be named `{primary-editor}-{draft-name}.md`.
47+
48+
If you would like to use the RFC I-D format, you can use the [markdown I-D template](https://github.com/martinthomson/i-d-template) as a starting point. You will need a reasonably recent version of Python 3 to run a local build, but the makefile will check out everything else it needs using a submodule and automatically create a virtual env for the build.
4749

4850
## License
4951

0 commit comments

Comments
 (0)