lightair/project-layout
1
0
Fork 0
mirror of https://github.com/golang-standards/project-layout.git synced 2026-02-04 06:06:18 +00:00
Code Issues Projects Releases Wiki Activity

more notes and notes in major directories

Browse Source
This commit is contained in:
Kyle Quest
2018-03-24 15:55:43 -07:00
parent 0ec166f195
commit 6298595c9e
19 changed files with 87 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
cmd/README.md Normal file
View File

@@ -0,0 +1,9 @@
# `/cmd`
Main applications for this project.
The directory name for each application should match the name of the executable you want to have (e.g., `/cmd/myapp`).
Don't put a lot of code in the application directory. If you think the code can be imported and used in other projects, then it should live in the `/pkg` directory. If the code is not reusable or if you don't want others to reuse it, put that code in the `/internal` directory. You'll be surprised what others will do, so be explicit about your intentions!
It's common to have a small `main` function that imports and invokes the code from the `/internal` and `/pkg` directories and nothing else.