jadefox10200 / goprint

Attempt at a windows printer in golang
MIT License
115 stars 28 forks source link

Documentation needed #7

Open jadefox10200 opened 2 years ago

jadefox10200 commented 2 years ago

This package seems to have gotten more attention than I thought it would. I have barely worked on it over the years. Anyone willing to do further documentation to make it more user friendly would be appreciated.

machship-mm commented 2 years ago

This package seems to have gotten more attention than I thought it would. I have barely worked on it over the years. Anyone willing to do further documentation to make it more user friendly would be appreciated.

I'm very interested in potentially using the package, and as part of that, will write some test cases to print common types of documents. If they end up working the way I think they should, I can contribute those as examples in a pull request if you'd like?

Also, when you say you'd like further documentation, are you:

My use case for the package will be to pass a byte array directly to the print method, so I'm going to need to change the code or provide additional methods. Would you entertain creating a versioned release so that we could create a new version with breaking changes?

Also, can you pick a license?

Thanks for putting the package together. I am thinking about writing a cross-platform print library for Go, and if you accept some proposed changes, I'll do the Windows side of that by calling your package.

jadefox10200 commented 2 years ago

Ok, I've added a license. However, I'm not very interested in versions. New methods should be used. Right now the package is quite manual. Meaning, it could easily use upgrades such as wrappers to pass in simplex/duplex, printer. I see no issue in adding methods of printing as many may be needed and so would rather keep to one version.

On the documentation, there needs to be better explanations. I made an example folder but many people don't know what lpr is for example and that's one method that the package uses to print. There are multiple. The readme.md is sparse and the code lacks any comments to define the methods and function so godoc isn't helpful for those wanting to know how to easily use it. Any examples you make are welcome in a pull request. Please place them in the examples folder and comment your code. Thank you.

machship-mm commented 2 years ago

No worries. I can't use it in that model, so I'll need to just write it all from scratch based on the MS docs.

Good luck with the library! Great work getting this up and running.

jadefox10200 commented 2 years ago

No worries. I can't use it in that model, so I'll need to just write it all from scratch based on the MS docs.

Good luck with the library! Great work getting this up and running.

I may have misunderstood your request. If you are talking about different releases, that would be acceptable. How did you intend to create the version?