Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added syntax description for puzzles, as per issue #95 on master repo.
  • Loading branch information
golyalpha committed Jun 19, 2018
1 parent 0e25181 commit 8387d47
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Expand Up @@ -55,6 +55,16 @@ pdd --exclude=src/**/* # exclude all files in src/
Every puzzle has to be formatted like this (pay attention
to the leading space in every consecutive line):

```java
/**
* @todo [puzzle marker]</[role]> <[description]>
*/
[related code]
```
\[\] - Replace with apropriate data (see text enclosed in brackets)
<> - Omitable (enclosed data can be left out)

Example:
```java
/**
* @todo #234:15m/DEV This is something to do later
Expand Down

0 comments on commit 8387d47

Please sign in to comment.