smock

package module

v0.0.3 Latest Latest Go to latest Published: Jun 26, 2021 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fcjr/smock

Links

Open Source Insights

README ¶

Smock

Instantly transform your screenshots to beautiful mockups.

Available Commands

Browser

Create browser-like mockups

Browser Command Example

Usage

Basic:

smock browser in.png out.png

Custom:

smock browser --background-color FFFFFF --background-alpha 255 --horizontal-padding 100 --vertical-padding 75

Installation

macOS

brew install fcjr/fcjr/smock

Windows

scoop bucket add fcjr https://github.com/fcjr/scoop-fcjr.git
scoop install smock

Other

If you are on another platform such as linux or just rather not use a package manager, you can download a binary from Github releases and use it straight away without having to install any additional dependencies.

Find the latest release, download the tar.gz file for your given operating system and extract it.
Inside you'll find the smock executable which you can run directly (Note: you may need to allow execution via chmod +x <PATH_TO_SMOCK_EXE>).

Development

Building the current commit

This project uses goreleaser.

Install go.
Install goreleaser via the steps here.
Build current commit via goreleaser release --snapshot --skip-publish --rm-dist.

Documentation ¶

Overview ¶

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index ¶

func Browser(img image.Image, opts *BrowserOptions) (image.Image, error)
func ParseHexColor(s string) (c color.RGBA, err error)
type BrowserOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Browser ¶

func Browser(img image.Image, opts *BrowserOptions) (image.Image, error)

func ParseHexColor ¶ added in v0.0.2

func ParseHexColor(s string) (c color.RGBA, err error)

Types ¶

type BrowserOptions ¶

type BrowserOptions struct {
	VerticalPadding   int
	HorizontalPadding int
	BackgroundColor   color.RGBA
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cli
cmd
version

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL