Skip to content

Commit

Permalink
Clarify auxiliary/image files and the template in EIP-1 (#2921)
Browse files Browse the repository at this point in the history
  • Loading branch information
axic authored Aug 29, 2020
1 parent 0c3a44e commit efcc99a
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions EIPS/eip-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,7 @@ Each EIP should have the following parts:

## EIP Formats and Templates

EIPs should be written in [markdown] format.
Image files should be included in a subdirectory of the `assets` folder for that EIP as follows: `assets/eip-N` (where **N** is to be replaced with the EIP number). When linking to an image in the EIP, use relative links such as `../assets/eip-1/image.png`.
EIPs should be written in [markdown] format. There is a [template](https://github.com/ethereum/EIPs/blob/master/eip-template.md) to follow.

## EIP Header Preamble

Expand Down Expand Up @@ -215,7 +214,7 @@ EIPs may also have a `superseded-by` header indicating that an EIP has been rend

## Auxiliary Files

EIPs may include auxiliary files such as diagrams. Such files must be named EIP-XXXX-Y.ext, where “XXXX” is the EIP number, “Y” is a serial number (starting at 1), and “ext” is replaced by the actual file extension (e.g. “png”).
Images, diagrams and auxiliary files should be included in a subdirectory of the `assets` folder for that EIP as follows: `assets/eip-N` (where **N** is to be replaced with the EIP number). When linking to an image in the EIP, use relative links such as `../assets/eip-1/image.png`.

## Transferring EIP Ownership

Expand Down

0 comments on commit efcc99a

Please sign in to comment.