diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..28d4854 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*.html +*.xml diff --git a/README.md b/README.md index 5ef820d..021f567 100755 --- a/README.md +++ b/README.md @@ -30,7 +30,25 @@ If you want to see how a threat intelligence can be easily expressed in MISP sta [Installing MISP](https://www.misp-project.org/download/) is also another option to see the MISP standards in action. The MISP standards are actively used in the MISP threat intelligence platform to support the complete chain from intelligence creation, sharing, distribution and synchronisation. +## Building the RFCs + +These RFCs use [mmark](https://mmark.nl/) to generate - get a release [from the Github Repo](https://github.com/miekg/mmark/releases) and make sure it's in your PATH. + +You'll also need `xml2rfc` - install using `sudo pip3 isntall xml2rfc` + +```bash +for directory in $(find . -type d -iname "misp*"); do; + echo "Building $directory..."; + cd $directory; + make; + cd ..; +done; +``` + +cd misp-core-format +make +``` + # Contribution If you want to contribute to the MISP specifications, feel free to [open an issue](https://github.com/MISP/misp-rfc/issues). - diff --git a/misp-core-format/Makefile b/misp-core-format/Makefile index 210eb88..73b05d7 100644 --- a/misp-core-format/Makefile +++ b/misp-core-format/Makefile @@ -1,4 +1,4 @@ -MMARK:=/home/adulau/git/mmark/mmark/mmark -xml2 -page +MMARK:=mmark -xml2 -page docs = $(wildcard *.md) @@ -6,4 +6,3 @@ all: $(docs) $(MMARK) $< > $<.xml xml2rfc --text $<.xml xml2rfc --html $<.xml - diff --git a/misp-galaxy-format/Makefile b/misp-galaxy-format/Makefile index 210eb88..8a7138f 100644 --- a/misp-galaxy-format/Makefile +++ b/misp-galaxy-format/Makefile @@ -1,4 +1,4 @@ -MMARK:=/home/adulau/git/mmark/mmark/mmark -xml2 -page +MMARK:=mmark -xml2 -page docs = $(wildcard *.md) diff --git a/misp-object-template-format/Makefile b/misp-object-template-format/Makefile index 210eb88..8a7138f 100644 --- a/misp-object-template-format/Makefile +++ b/misp-object-template-format/Makefile @@ -1,4 +1,4 @@ -MMARK:=/home/adulau/git/mmark/mmark/mmark -xml2 -page +MMARK:=mmark -xml2 -page docs = $(wildcard *.md) diff --git a/misp-query-format/Makefile b/misp-query-format/Makefile index 210eb88..8a7138f 100644 --- a/misp-query-format/Makefile +++ b/misp-query-format/Makefile @@ -1,4 +1,4 @@ -MMARK:=/home/adulau/git/mmark/mmark/mmark -xml2 -page +MMARK:=mmark -xml2 -page docs = $(wildcard *.md) diff --git a/misp-taxonomy-format/Makefile b/misp-taxonomy-format/Makefile index 210eb88..8a7138f 100644 --- a/misp-taxonomy-format/Makefile +++ b/misp-taxonomy-format/Makefile @@ -1,4 +1,4 @@ -MMARK:=/home/adulau/git/mmark/mmark/mmark -xml2 -page +MMARK:=mmark -xml2 -page docs = $(wildcard *.md)