Browse Source

(doc) update readme files

Rob Reynolds 7 years ago
parent
commit
3bc20bce07
3 changed files with 26 additions and 0 deletions
  1. 14 0
      README.md
  2. 5 0
      automatic/README.md
  3. 7 0
      automatic/_output/README.md

+ 14 - 0
README.md

@@ -0,0 +1,14 @@
+## Chocolatey Packages Template
+
+This contains Chocolatey packages, both manually and automatically maintained.
+
+### Folder Structure
+
+* automatic - where automatic packaging and packages are kept. These are packages that are automatically maintained using either [AU](https://chocolatey.org/packages/au) or [Ketarin](https://chocolatey.org/packages/ketarin)/[ChocolateyPackageUpdater](https://chocolatey.org/packages/chocolateypackageupdater) combo.
+* icons - Where you keep icon files for the packages. This is done to reduce issues when packages themselves move around.
+* ketarin - where ketarin jobs (aka applications or searches) exported as XML are kept. This is done to allow easy of contribution.
+* manual - where packages that are not automatic are kept.
+* ops - scripts, jobs, and other items for ensuring automatic packaging.
+* setup - items for prepping the system to ensure for auto packaging.
+
+For setting up your own automatic package repository, please see [Automatic Packaging](https://chocolatey.org/docs/automatic-packages)

+ 5 - 0
automatic/README.md

@@ -0,0 +1,5 @@
+## Automatic Folder
+
+This is where you put your Chocolatey packages that are automatically packaged up by either [AU](https://chocolatey.org/packages/au) or [Ketarin](https://chocolatey.org/packages/ketarin)/[ChocolateyPackageUpdater](https://chocolatey.org/packages/chocolateypackageupdater).
+
+You may want to drop the actual ketarin files in the top-level Ketarin folder to keep them separate from the packages themselves.

+ 7 - 0
automatic/_output/README.md

@@ -0,0 +1,7 @@
+# Output Folder
+
+When using Ketarin / Chocolatey Package Updater (chocopkgup) combo for keeping packages up to date, this folder will contain the output of generating those packages.
+
+This is the folder where chocopkgup will point to when configured to use the automatic folder (the parent folder of this) as the PackagesFolder.
+
+You will want to configure chocopkgup (chocopkgup.exe.config file in the package folder) to point to this directory.