Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.74 KB

README.md

File metadata and controls

46 lines (31 loc) · 1.74 KB
Raw

tweego-bin

NPM badge License MIT-0

An unofficial NPM wrapper for the Tweego compiler by @tmedwards.

Similar to mattrossman/tweego-node, but has no runtime dependencies.

On installation, downloads the release ZIP for your system, and extracts it to bin/. NPM will create a symlink to tweego and storyformats inside the folder located at $(npm bin) or $(npm bin -g).

How to use

Global installation: This will allow you to use tweego as a shell command.

# Install
npm install --global tweego-bin
# Check that it worked.
tweego --list-formats

Project-level installation: allows using Tweego inside scripts in package.json.

# Install
npm install --save-dev tweego-bin
# Check that it worked.
npm exec -c 'tweego --list-formats'

See the official Tweego docs for using Tweego.

Known issues

  • On Win32, npm will create a broken PowerShell shim called tweego.ps1.
    • To remove the broken shim, invoke Remove-Item (Join-Path (npm bin -g) "\tweego.ps1").
  • Builds are only available for x64 and x84 Windows, macOS, and Linux.
    • On an ARM64 Mac, the script will download the x64 version (requires Rosetta 2).
  • Stream-based unzipping may behave unexpectedly slowly on some platforms.

License

Copyright (c) 2021, 2022 Double-A

Licensed under the MIT No Attribution (MIT-0) license.