From 261a964b30e6fd0da0e8dd10335129c3770be52b Mon Sep 17 00:00:00 2001 From: Nils Philippsen Date: Aug 22 2018 15:21:17 +0000 Subject: add "Getting started" section mentioning fedmod --- diff --git a/modules/ROOT/pages/making-modules/defining-modules.adoc b/modules/ROOT/pages/making-modules/defining-modules.adoc index 1a37ec5..50a9c4b 100644 --- a/modules/ROOT/pages/making-modules/defining-modules.adoc +++ b/modules/ROOT/pages/making-modules/defining-modules.adoc @@ -2,6 +2,17 @@ Simply put, a **https://github.com/fedora-modularity/libmodulemd/blob/master/spec.v2.yaml[modulemd] is a file that defines which packages get built for which releases**. It includes a summary and a description, a list of source RPM packages, build information i.e. build order and macros, and usage information i.e. installation profiles and licenses. +== Getting started + +To get started quickly, you can use the `fedmod` tool (from the package of the same name) to create a skeletal modulemd file for your module based on one or more source packages, e.g.:: +[source,shell] +---- +$ fedmod fetch-metadata +$ fedmod rpm2package dwm > dwm.yaml +---- + +If you specify more than one package it will fill in the summary and description fields from their counterparts in the first specified package. + == A typical modulemd example A typical modulemd file looks similar to the following examples. Read on for more details about each part of the modulemd file.