diff --git a/README.md b/README.md index dc07f88..75ada21 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ -# go-project-layout -My understanding of how to structure a golang project. +# Go Project Layout +This is my understanding of how to structure `Go` project layout. + +## References +- [GopherCon UK 2018: Kat Zien - How do you structure your Go apps?](https://www.youtube.com/watch?v=VQym87o91f8&t=3s) + - This's an amazing talk for the `Go` project layout I think. + - Slides and Code examples can be found in: [katzien/go-structure-examples](https://github.com/katzien/go-structure-examples) +- [Standard Go Project Layout](https://github.com/golang-standards/project-layout) + - [No, it's NOT a golang standard!!!](https://github.com/golang-standards/project-layout/issues/38) See more in [Delete this repo #36](https://github.com/golang-standards/project-layout/issues/36) and [This repository has multiple serious issues #41](https://github.com/golang-standards/project-layout/issues/41). + - It's just an organization name "golang-standards" used by some one to manage these repos. It's harmful if you really think it's a standard and try to always follow it. + - On the other hand, I think this repo still have some benifits: collects many resources for the "golang-project-layout" question, gives suggestion for how to do it, etc. + - Try to read it as a post, think about what's valueable for you. + - [More resources metioned in #36](https://github.com/golang-standards/project-layout/issues/36#issue-479438391) +- [Ben Johnson - Standard Package Layout](https://medium.com/@benbjohnson/standard-package-layout-7cdbc8391fc1) +- [Ben Johnson - Building WTF Dial](https://medium.com/wtf-dial/wtf-dial-domain-model-9655cd523182) +- [Kyle C. Quest - Go Project Layout](https://medium.com/golang-learn/go-project-layout-e5213cdcfaa2) +- [Golang UK Conference 2017 | Mat Ryer - Writing Beautiful Packages in Go](https://www.youtube.com/watch?v=cAWlv2SeQus) +- [CodeBear801 - Golang Package layout](https://github.com/CodeBear801/tech_summary/blob/master/tech-summary/language/go/go-package-layout.md) +- [golang/go](https://github.com/golang/go) +- [moby/moby](https://github.com/moby/moby) +- [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) +