Browse Source

Minor changes to README.

master
Hernâni Marques 3 years ago
parent
commit
0b8980a7da
1 changed files with 13 additions and 16 deletions
  1. +13
    -16
      README.txt

+ 13
- 16
README.txt View File

@ -1,16 +1,17 @@
Contents
========
This repository contains different p≡p Internet-Drafts -- some already
submitted in different versions, others under development and yet to
be submitted in a first version -- to the IETF Internet-Drafts repository:
This repository contains different p≡p and other (e.g., MEDUP)
Internet-Drafts, some already submitted in different versions, others under
development and yet to be submitted in a first version -- to the IETF
Internet-Drafts repository:
https://www.ietf.org/id-info/
In each directory an Internet-Draft (I-D) is provided, these for now being:
In each directory an Internet-Draft (I-D) is provided, e.g.:
* pep (pEp's general draft)
* pep-email (pEp with email)
* pep-email (pEp for email)
* pep-handshake (pEp's method to authenticate peers)
* pep-keysync (pEp's method to synchronize secret keys)
* pep-rating (pEp's rating system to signal privacy levels)
@ -32,9 +33,8 @@ system or directly from the respective sites:
* https://www.ruby-lang.org/
* https://xml2rfc.tools.ietf.org/
You can also also install kramdown-rfc2629 through the ruby gem
packaging system if your packaging system doesn't know anything
about this tool:
You can also install kramdown-rfc2629 through the ruby gem packaging system
if your packaging system doesn't know anything about this tool:
https://rubygems.org/
@ -63,9 +63,9 @@ Basic metadata (e.g., authors' names, email addresses and the draft title),
but also references (including RFCs, by instance) are made available through
a special syntax at the beginning of the Markdown file.
Makefile contains the build instructions to generate the I-Ds in the required
Makefiles contain the build instructions to generate the I-Ds in the required
ASCII and xml2rfc v2 forms accepted by the IETF submission system. Additionally,
it also creates an HTML version.
they also create HTML versions.
By default, revision number (REV) is set to "00": make sure to increment this
as IETF contributions are furthered.
@ -76,28 +76,25 @@ Version Control System (Mercurial)
Most important commands:
* download repository / initialization
* Download repository / initialization:
1) hg clone https://pep.foundation/dev/repos/internet-drafts/
* Update local directories to latest repository state:
1) hg pull
2) hg update
Note: Merge handling may be required to take care of
Note: Merge handling (by ``hg merge'') may be required to take care of
(if indicated after hg update)
* Upload local changes to repository
Important: To avoid conflicts, _always_ update the local directories
to latest repository state (see commands in last bullet point)
_before_commit_!
*before* doing a commit!
1) hg commit -m "<Changelog, short description of changes>" [ <filename> ]
2) hg push
More information:
* https://www.mercurial-scm.org/


Loading…
Cancel
Save