cybercyst/project-layout
1
0
Fork 0
mirror of https://github.com/golang-standards/project-layout.git synced 2025-05-05 15:43:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

additional /cmd application directory clarification

Browse Source
This commit is contained in:
Kyle Quest 2018-01-31 17:45:24 -08:00
parent 409b946bf4
commit 0ec166f195
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -14,7 +14,7 @@ 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.
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.