49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
# Go Library Template
|
|
|
|
## Structure
|
|
```
|
|
my-lib/
|
|
├── lib1/ # Individual importable library. Duplicate as needed
|
|
│ ├── lib1.go
|
|
│ └── lib1_test.go
|
|
└── internal/
|
|
└── pkg1/ # Internal use package. Duplicate as needed
|
|
├── pgk1.go
|
|
└── pgk1_test.go
|
|
```
|
|
|
|
## Use
|
|
- `git clone git.develent.net/wiharb/go-template-app.git [project-name]`
|
|
- `cd ./[project-name]`
|
|
- `rm -rf ./.git`
|
|
- Rename and duplicate `cmd/app1` and `internal/pkg1` as needed
|
|
- `go mod init [package_name]`
|
|
- Update `./.vscode/launch.json::"program"` to the correct binary path(s)
|
|
- Reinitialize git
|
|
- `git init`
|
|
- `git add .`
|
|
- `git commit -m "init"`
|
|
- `git remote add origin https://git.develenet.net/wiharb/[repo].git`
|
|
- `git push -u origin master`
|
|
|
|
--- DELETE AFTER INITIALIZATION ^
|
|
|
|
# Project Name
|
|
|
|
## Overview
|
|
[One or two sentences explaining what the project does and why it exists]
|
|
|
|
## Features
|
|
[Bullet points of what it can do]
|
|
|
|
## Installation
|
|
[How to install the app or add the module]
|
|
|
|
## Usage
|
|
[CLI examples for apps, code snippets for libs]
|
|
|
|
## (Optional)Configuration
|
|
[ Describe `.env`, config files, or CLI flags]
|
|
|
|
## (Optional)Contributing
|
|
[How to build, test, and contribute] |