diff --git a/README.md b/README.md index 6ac5f53..0784cd5 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ Additional documents: - [Part numbers](https://github.com/git-plm/parts/blob/main/partnumbers.md) - [Changelog](CHANGELOG.md) +- [Windows notes](windows.md) GitPLM is a tool and a collection of best practices for managing information needed to manufacture products. @@ -67,7 +68,8 @@ Usage of gitplm: ## Configuration -GitPLM supports configuration via YAML files. The tool will look for configuration files in the following order: +GitPLM supports configuration via YAML files. The tool will look for +configuration files in the following order: 1. Current directory: `gitplm.yaml`, `gitplm.yml`, `.gitplm.yaml`, `.gitplm.yml` 2. Home directory: `~/.gitplm.yaml`, `~/.gitplm.yml` @@ -151,18 +153,23 @@ directories which are identified by one or both of the following files: GitPLM supports two file naming patterns for source files: -1. **Base pattern**: `CCC-NNN.csv` and `CCC-NNN.yml` (e.g., `PCB-019.csv`, `ASY-023.yml`) -2. **Variation pattern**: `CCC-NNN-VV.csv` and `CCC-NNN-VV.yml` (e.g., `PCB-019-01.csv`, `ASY-023-02.yml`) +1. **Base pattern**: `CCC-NNN.csv` and `CCC-NNN.yml` (e.g., `PCB-019.csv`, + `ASY-023.yml`) +2. **Variation pattern**: `CCC-NNN-VV.csv` and `CCC-NNN-VV.yml` (e.g., + `PCB-019-01.csv`, `ASY-023-02.yml`) + +The variation pattern uses the first two digits of the variation number, +allowing you to organize files by variation ranges. For example: -The variation pattern uses the first two digits of the variation number, allowing you to organize files by variation ranges. For example: - `PCB-019-00.csv` for variations 0000-0099 - `PCB-019-01.csv` for variations 0100-0199 - `PCB-019-02.csv` for variations 0200-0299 -When processing a release, GitPLM first searches for the base pattern, then falls back to the variation pattern if the base pattern is not found. +When processing a release, GitPLM first searches for the base pattern, then +falls back to the variation pattern if the base pattern is not found. -If either of these files is found, GitPLM considers this a source directory and will -use this directory to generate release directories. +If either of these files is found, GitPLM considers this a source directory and +will use this directory to generate release directories. A source directory might contain: diff --git a/windows.md b/windows.md new file mode 100644 index 0000000..378b2d0 --- /dev/null +++ b/windows.md @@ -0,0 +1,27 @@ +# Using GitPLM on Windows + +(the following was tested on Windows 10. Feel free to open a PR if you have +better ideas or have tested on other versions.) + +The GitPLM binaries are not signed, so some effort is required to get past all +the Windows security checks. If someone would like to contribute a process to +sign the binaries for Windows that is not too arduous, that would be +appreciated. + +1. Download the appropriate Windows + [release](https://github.com/git-plm/gitplm/releases). For most people, this + will be the `windows-x86_64`. If you have a newer ARM based (such as the new + Surface), you may need the `windows-arm64` release. +1. extact the downloaded zip file +1. Windows may complain about the program because it is from an Unknown + publisher. It appears that programs + [written in Go are often flagged](https://github.com/microsoft/go/issues/1255). + If Windows pops upa Virus & threat protection dialog, click on the "Severe" + text, and select "Allow on device", then "Start actions". +1. Double click on the `gitplm` binary in windows Explorer. Windows may show a + Windows protected your PC dialog. Click on the "More info" link and select + "Run Anyway". gitplm should now and ask you to enter a directory containing + partmaster csv files. +1. cp the `gitplm` binary to the `C:\bin` directory. +1. add `C:\bin` to your system path (System properties->Environment variables) +1. now in powershell, you should be able to run `gitplm`.