Move or copy docs into package doc?

JeffPaine / csvsplit

Split a .csv file into multiple files

MIT License

5 stars 4 forks source link

Move or copy docs into package doc? #7

Closed JeffPaine closed 10 years ago

JeffPaine commented 10 years ago

To be more idiomatically go, the package documentation ought to be in comments directly above the package main declaration. The only concern I have is with either having an anemic README.md or having full versions of both but having to keep them in sync.

JeffPaine commented 10 years ago

So, I decided to go with a url to the project on github and to use a nice README.md file for all the documentation. No fully idiomatic, but pragmatic.