mrtazz / checkmake

experimental linter/analyzer for Makefiles
MIT License
1.04k stars 45 forks source link

Windows documentation #42

Open PaulBenn opened 4 years ago

PaulBenn commented 4 years ago

Hi, there should be a minimal amount of documentation for Windows users who would like to make use of your package. At the moment, following README instructions using Windows results in the an error upon running go get github.com/mrtazz/checkmate. See below the suggested fix for details.

SUGGESTED FIX

Simply add the following alternate instruction for operating systems that do not support symlinks, such as Windows:

go get github.com/mrtazz/checkmake/cmd/checkmake

This installs the package successfully.

Expected behaviour

Successful install (no console output)

Actual behaviour

Installation error:

package github.com/mrtazz/checkmake:
Users\Paul.Benn-Darias\go\src\github.com\mrtazz\checkmake\checkmake.go:1:1: expected 'package', found '.'

Output of checkmake --version

checkmake built at by with

This does not seem to be printing the correct version, but I've used the latest tag.

Output of checkmake --debug <your makefile>

N/A as this is an installation problem.

Output of make --version

Copyright (C) 2006  Free Software Foundation, Inc.
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.

This program built for i386-pc-mingw32

Sample Makefile to reproduce issue

N/A as this is an installation issue.