Skip to content

alexruperez/swift-executable-template

Repository files navigation

EXECUTABLE-NAME

A description of this tool.

Twitter Swift License Swift Package Manager Swift Action Coverage Documentation

🌟 Features

🐒 Usage

Command Line

Simply run:

$ 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:

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

Using Mint:

$ mint install AUTHOR-HANDLE/EXECUTABLE-NAME

Compiling from source:

$ 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.

Use as CLI

$ 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:

.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.

🍻 Etc.

  • Contributions are very welcome.
  • Attribution is appreciated (let's spread the word!), but not mandatory.

👨‍💻 Author

AUTHOR-NAME – @AUTHOR-HANDLE – AUTHOR-EMAIL

👮‍♂️ License

EXECUTABLE-NAME is available under the MIT license. See the LICENSE file for more info.