diff --git a/Cargo.toml b/Cargo.toml index 8b9c5a7..eae1b92 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,8 +5,6 @@ edition = "2021" description = "Utility (and mini-language) for shell completions (\"tab completion\") for external programs" license = "MIT" -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html - [dependencies] anyhow = "1.0.72" serde = { version = "1.0", features = ["derive"] } @@ -17,3 +15,23 @@ winnow = "0.6.18" [dev-dependencies] assert-json-diff = "2.0.2" + +[package.metadata.deb] +maintainer = "Evan Battaglia " +copyright = "2024, Evan Battaglia " +license-file = ["LICENSE", "2"] +extended-description = """\ +Tabry allows you to easily write tab completion for external \ +commands which do not support tab completion, including your \ +own scripts and aliases. tabry especially targets CLIs with \ +"git-style" subcommands or nested subcommands. \ +See https://github.com/evanbattaglia/tabry and \ +/usr/share/doc/tabry/README.md for more information.""" +depends = "$auto" +section = "utility" +priority = "optional" +assets = [ + ["target/release/tabry", "usr/bin/", "755"], + ["README.md", "usr/share/doc/tabry/README.md", "644"], + ["examples/*/*", "usr/share/doc/tabry/examples", "644"] +] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a2f9160 --- /dev/null +++ b/LICENSE @@ -0,0 +1,8 @@ +Copyright 2024 Evan Battaglia + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + diff --git a/TODO.md b/TODO.md index 50c2f34..7366fc6 100644 --- a/TODO.md +++ b/TODO.md @@ -1,10 +1,16 @@ TODO before "public announcement" -* put on cargo; nix; instructions for installing. Maybe brew & deb too. -* test on zsh, fish ---- very soon after +* fish and nix support merged +* zsh support/testing +* go through TODOs +* get remaning example tests from ruby working * combining the three includes (sub, arg, flag) in the JSON format would be great +--- +* put on cargo +* bump version number and add deb +* better instructions for installing (build from source, cargo, nix, deb) + +-- very soon after * flags like -abc -> -a, -b, -c -* go through TODOs -- soon after * tests to 80% coverage (goal 100% eventually) * set up github automated tests