e91b419af5
- Write introduction - Move large readme sections into book - Rename docs to www type: documentation
2.5 KiB
intermodal: a 40' shipping container for the Internet
Intermodal is a user-friendly and featureful command-line BitTorrent metainfo
(.torrent file) creation, viewing, and verification tool. The Intermodal
binary is called imdl.
Manual
General
Installation
Supported Operating Systems
imdl supports both unix and Windows. It is tested on Linux, MacOS, and
Windows, but should work on other unix OSs. If it does not, please open an
issue!
Pre-built binaries
Pre-built binaries for Linux, macOS, and Windows can be found on the releases page.
You can use the following command to download the latest binary for Linux,
MacOS or Windows, just replace DEST with the directory where you'd like to
install the imdl binary:
curl --proto '=https' --tlsv1.2 -sSf https://imdl.io/install.sh | bash -s -- --to DEST
Cargo
imdl is written in Rust and can be built from
source and installed with cargo install imdl. To get Rust, use the
rustup installer.
Semantic Versioning
Intermodal follows semantic versioning.
In particular:
- v0.0.X: Breaking changes may be introduced at any time.
- v0.X.Y: Breaking changes may only be introduced with a minor version number bump.
- vX.Y.Z: Breaking changes may only be introduced with a major version number bump
Unstable Features
To avoid premature stabilization and excessive version churn, unstable features
are unavailable unless the --unstable / -u flag is passed, for example
imdl --unstable torrent create .. Unstable features may be changed or removed
at any time.
Acknowledgments
The formatting of imdl torrent show is entirely copied from
torf, an excellent command-line torrent
creator, editor, and viewer.