https://github.com/alexruperez/swift-executable-template

Swift Executable Template, just run ./generate.sh
https://github.com/alexruperez/swift-executable-template

swift-cli swift-template swiftcli template

Last synced: 4 months ago
JSON representation

Swift Executable Template, just run ./generate.sh

• Host: GitHub
• URL: https://github.com/alexruperez/swift-executable-template
• Owner: alexruperez
• License: mit
• Created: 2020-04-11T14:27:45.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-17T10:51:57.000Z (over 5 years ago)
• Last Synced: 2025-07-21T15:24:28.974Z (6 months ago)
• Topics: swift-cli, swift-template, swiftcli, template
• Language: Swift
• Size: 23.4 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# EXECUTABLE-NAME

> A description of this tool.

[![Twitter](https://img.shields.io/badge/contact-%40AUTHOR-HANDLE-blue)](http://twitter.com/AUTHOR-HANDLE)

[![Swift](https://img.shields.io/badge/swift-5-orange)](https://swift.org)

[![License](https://img.shields.io/github/license/AUTHOR-HANDLE/EXECUTABLE-NAME)](LICENSE)

[![Swift Package Manager](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-4BC51D.svg?style=flat)](https://swift.org/package-manager)

[![Swift Action](https://github.com/AUTHOR-HANDLE/EXECUTABLE-NAME/workflows/Swift/badge.svg)](https://github.com/AUTHOR-HANDLE/EXECUTABLE-NAME/actions)

[![Coverage](https://codecov.io/gh/AUTHOR-HANDLE/EXECUTABLE-NAME/branch/master/graph/badge.svg)](https://codecov.io/gh/AUTHOR-HANDLE/EXECUTABLE-NAME)

[![Documentation](https://AUTHOR-HANDLE.github.io/EXECUTABLE-NAME/badge.svg)](https://AUTHOR-HANDLE.github.io/EXECUTABLE-NAME)

## 🌟 Features

## 🐒 Usage

### Command Line

Simply run:

```sh

$ EXECUTABLE-NAME [options]

```

* `-h, --help`: Show `EXECUTABLE-NAME` help information.

* `--version`: Show `EXECUTABLE-NAME` version.

## 🛠 Compatibility

- macOS 10.15+

- Linux

## ⚙️ Installation

Make sure Xcode 11.4+ is installed first.

There're more than one way to install `EXECUTABLE-NAME`.

### Using [Homebrew](https://brew.sh):

```sh

$ brew install AUTHOR-HANDLE/EXECUTABLE-NAME/formula

```

### Using [Mint](https://github.com/yonaskolb/mint):

```sh

$ mint install AUTHOR-HANDLE/EXECUTABLE-NAME

```

### Compiling from source:

```sh

$ git clone https://github.com/AUTHOR-HANDLE/EXECUTABLE-NAME.git

$ cd EXECUTABLE-NAME

$ make install

```

With that installed and in the `/usr/local/bin` folder, now it's ready to serve.

### Using [Swift Package Manager](https://github.com/apple/swift-package-manager):

**Use as CLI**

```shell

$ git clone https://github.com/AUTHOR-HANDLE/EXECUTABLE-NAME.git

$ cd EXECUTABLE-NAME

$ swift run

```

**Use as dependency**

Add the following to your Package.swift file's dependencies:

```swift

.package(url: "https://github.com/AUTHOR-HANDLE/EXECUTABLE-NAME.git", from: "0.1.0")

```

And then import wherever needed: `import EXECUTABLE-NAME`

*For more information, see [the Swift Package Manager documentation](https://github.com/apple/swift-package-manager/tree/master/Documentation).*

## 🍻 Etc.

- Contributions are very welcome.

- Attribution is appreciated (let's spread the word!), but not mandatory.

## 👨‍💻 Author

AUTHOR-NAME – [@AUTHOR-HANDLE](https://twitter.com/AUTHOR-HANDLE) – AUTHOR-EMAIL

## 👮‍♂️ License

*EXECUTABLE-NAME* is available under the MIT license. See the [LICENSE](LICENSE) file for more info.