chore: add comments for all packages (#350)

Co-authored-by: rick <[email protected]>

Author: LinuxSuRen

cmd/doc.go

@@ -0,0 +1,2 @@
+// Package cmd provides the CLI commands
+package cmd

pkg/common/doc.go

@@ -0,0 +1,2 @@
+// Package common provides some common functions for the whole project.
+package common

pkg/compress/doc.go

@@ -0,0 +1,2 @@
+// Package compress provides the compress and uncompress functions.
+package compress

pkg/doc.go

@@ -0,0 +1,3 @@
+// Package pkg provides the features to interal and external users.
+// All CLI related logics should not be in this package.
+package pkg

pkg/exec/doc.go

@@ -0,0 +1,3 @@
+// Package exec is the wrapper of os/exec package.
+// The main purpose of this package is to make unit test be easier.
+package exec

pkg/installer/doc.go

@@ -0,0 +1,2 @@
+// Package installer is the core part of the software package installation.
+package installer

pkg/log/doc.go

@@ -0,0 +1,3 @@
+// Package log provides the core logger functions.
+// Basically, this is a wrapper of log.Logger
+package log

pkg/net/doc.go

@@ -0,0 +1,2 @@
+// Package net provides the core download functions
+package net

pkg/os/apk/doc.go

@@ -0,0 +1,3 @@
+// Package apk provides the common functions to install a package via apk.
+// See also https://wiki.alpinelinux.org/wiki/Alpine_Package_Keeper.
+package apk

pkg/os/apt/doc.go

@@ -0,0 +1,3 @@
+// Package apt provides the common functions to install a package via apt.
+// See also https://en.wikipedia.org/wiki/APT_(software).
+package apt