From 319a1dbe4e6147cfe3e474dc03ae281b84a8765c Mon Sep 17 00:00:00 2001 From: Mathieu Lirzin Date: Fri, 29 Sep 2017 16:52:48 +0200 Subject: maint: Replace "README--git" with "HACKING" * README--git: Delete. * HACKING: New file documenting how to contribute to Mcron. * Makefile.am (EXTRA_DIST): Distribute it. --- HACKING | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 HACKING (limited to 'HACKING') diff --git a/HACKING b/HACKING new file mode 100644 index 0000000..a9e9f5a --- /dev/null +++ b/HACKING @@ -0,0 +1,76 @@ +These notes intend to help people working on the checked-out sources. +These requirements do not apply when building from a distribution tarball. + +* First Git checkout + +You can get a copy of the source repository like this: + + $ git clone git://git.sv.gnu.org/mcron + $ cd mcron + +The next step is to get and check other files needed to build, which are +extracted from other source packages: + + $ ./bootstrap + +And there you are! Just + + $ ./configure + $ make + +At this point, there should be no difference between your local copy, and the +Git master copy: + + $ git diff + +should output no difference. + +Enjoy! + +* Submitting patches + +If you develop a fix or a new feature, please send it to the appropriate +bug-reporting address as reported by the --help option of each program. One +way to do this is to use vc-dwim ), as +follows. + + Run the command "vc-dwim --help", copy its definition of the + "git-changelog-symlink-init" function into your shell, and then run this + function at the top-level directory of the package. + + Edit the (empty) ChangeLog file that this command creates, creating a + properly-formatted entry according to the GNU coding standards + . + + Make your changes. + + Run the command "vc-dwim" and make sure its output (the diff of all your + changes) looks good. + + Run "vc-dwim --commit". + + Run the command "git format-patch --stdout -1", and email its output in, + using the output's subject line. + +----- + +Copyright © 2002-2017 Free Software Foundation, Inc. +Copyright © 2017 Mathieu Lirzin + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +Local Variables: +mode: outline +fill-column: 78 +End: -- cgit v1.2.3