Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skeptycal/defaults
https://github.com/skeptycal/defaults
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/skeptycal/defaults
- Owner: skeptycal
- License: mit
- Created: 2022-01-25T07:20:38.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-16T01:01:31.000Z (over 1 year ago)
- Last Synced: 2023-07-27T22:37:47.922Z (over 1 year ago)
- Language: Go
- Size: 226 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# defaults
> Tricky and fun utilities for Go programs.
---
 
[](code-of-conduct.md)
 
---
## Getting Started
### Prerequisites
- [Go](https://golang.org/)
- [Git](https://git-scm.com/)
- [GitHub CLI](https://cli.github.com/)
-
Developed with go version go1.17.6 darwin/arm64. Go is _extremely_ backwards compatible and semver stable. Nearly any v1.x should work fine.
---
### Installation
To use this repo as a template for your own project:
```sh
gh repo create -y --public --template "https://github.com/skeptycal/defaults"
```
Clone this repo to test and contribute:
```bash
# add repo to $GOPATH (xxxxxx is your computer login username)
go get github.com/xxxxxx/defaults
cd ${GOPATH}/src/github.com/xxxxxx/defaults
# test results and coverage info
./go.test.sh
# install as a utility package
go install
```
Use the [Issues][issues] and [PR][pr] templates on the GitHub repo page to contribute.
---
### Basic Usage
> This is a copy of the example script available in the `cmd/example/defaults` folder:
```go
package main
import "github.com/skeptycal/defaults"
func main() {
defaults.Example()
}
```
To try it out:
```sh
# change to the sample folder
cd cmd/example/defaults
# run the main.go program
go run ./main.go
# to compile as an executable
go build
```
---
## Code of Conduct and Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us. Please read the [Code of Conduct](CODE_OF_CONDUCT.md) for details before submitting anything.
---
## Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
---
## Contributors and Inspiration
- Michael Treanor ([GitHub][github] / [Twitter][twitter]) - Initial work, updates, maintainer
- [Francesc Campoy][campoy] - Inspiration and great YouTube videos!
See also the list of contributors who participated in this project.
---
## License
Licensed under the MIT - see the [LICENSE](LICENSE) file for details.
[twitter]: (https://www.twitter.com/skeptycal)
[github]: (https://github.com/skeptycal)
[campoy]: (https://github.com/campoy)
[fatih]: (https://github.com/fatih/color)
[issues]: (https://github.com/skeptycal/defaults/issues)
[pr]: (https://github.com/skeptycal/defaults/pulls)