[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[Libguestfs] [PATCH] HACKING: Add a basic documentation for contributors



This patch is for guestfs-tools.

It points people in the right direction to get started with
the repo. Just refers to libguestfs docs.

Cheers,

Stef

-- 
Stef Walter (he / his)
Linux Engineering
Red Hat
>From ab99617581a43b9fb6d5457adcde2f2a13c2d31a Mon Sep 17 00:00:00 2001
From: Stef Walter <stefw redhat com>
Date: Fri, 21 May 2021 13:18:33 +0200
Subject: [PATCH] HACKING: Add a basic documentation for contributors

This points people in the right direction to get started with
the repo. Just refers to libguestfs docs.
---
 HACKING | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 HACKING

diff --git a/HACKING b/HACKING
new file mode 100644
index 00000000..98206626
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,15 @@
+To learn how to compile guestfs-tools from sources:
+
+  guestfs-building(1)  or  http://libguestfs.org/guestfs-building.1.html
+
+To learn how to extend guestfs-tools:
+
+  guestfs-hacking(1)       http://libguestfs.org/guestfs-hacking.1.html
+
+Although the above documentation applies specifically to libguestfs,
+this project was split from that repo, and similar steps and principles
+apply.
+
+For example, replace libguestfs with guestfs-tools in commands like:
+
+    dnf builddep guestfs-tools
-- 
2.31.1


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]