From 5a1bfbb8eec6655c1b553bf23a8a2b669a8c04d4 Mon Sep 17 00:00:00 2001 From: Artemy Date: Thu, 30 May 2024 12:56:58 +0300 Subject: [PATCH] doc: update --- Cargo.lock | 2 +- Cargo.toml | 10 ++++++++-- LICENSE | 21 +++++++++++++++++++++ README.md | 20 +++++++++++++++++++- 4 files changed, 49 insertions(+), 4 deletions(-) create mode 100644 LICENSE diff --git a/Cargo.lock b/Cargo.lock index d6d66a0..b4c9072 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -105,7 +105,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" [[package]] -name = "cimengine-build-tools" +name = "cimengine" version = "2.0.0" dependencies = [ "clap", diff --git a/Cargo.toml b/Cargo.toml index 533ceb3..349e368 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,9 +1,15 @@ [package] -name = "cimengine-build-tools" +name = "cimengine" version = "2.0.0" edition = "2021" -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +authors = ["artegoser"] +license = "MIT" +description = "Country info map engine build tools" +repository = "https://github.com/CIMEngine/cimengine" +readme = "./README.md" +keywords = ["geo", "geospatial", "build", "tools", "cli"] +categories = ["command-line-utilities"] [dependencies] clap = { version = "4.5.4", features = ["derive"] } diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2fa0e10 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Artemy "artegoser" Egorov + +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/README.md b/README.md index 7c38819..00e6c3c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ -This is new version. WIP rewriting on rust. +# CIMEngine build tools + +## Installation + +```bash +cargo install cimengine +``` + +or check releases + +## Usage + +CLI well-documented, use help command + +```bash +cimengine -h +``` + +## Old To see the old version, goto [old-branch](https://github.com/CIMEngine/cimengine-build-tools/tree/old-js)