Add package generation manual (#26)

* Add package generation manual
* Linter issues fix

Author: arkjedrz

Cargo.toml

@@ -5,6 +5,8 @@ edition = "2021"
 description = """
 `zxc` is a directory-oriented command runner.
 This means it is able to run commands defined by YAML files."""
+repository = "https://github.com/arkjedrz/zxc"
+license = "MIT"
 authors = ["Arkadiusz Jędrzejewski"]
 
 [dependencies]
@@ -18,3 +20,8 @@ run_script = "0.11"
 tempfile = "3.16"
 fsio = "0.4"
 serial_test = "3.2"
+
+[package.metadata.generate-rpm]
+assets = [
+    { source = "target/release/zxc", dest = "/usr/bin/zxc", mode = "755" },
+]

README.md

@@ -3,22 +3,6 @@
 `zxc` is a directory-oriented command runner.
 This means it is able to run commands defined by YAML files.
 
-## Pre-commit setup
-
-[pre-commit](https://pre-commit.com/) tool is used.
-
-To install pre-commit hooks:
-
-```bash
-pre-commit install
-```
-
-To run pre-commit hooks:
-
-```bash
-pre-commit run -a
-```
-
 ## Basics of operation
 
 ### Definition files location
@@ -94,3 +78,44 @@ Use following command to print `Hello John!`:
 ```bash
 zxc greet --name John
 ```
+
+## Development
+
+```bash
+pip install pre-commit
+cargo install cargo-deb cargo-generate-rpm cargo-aur
+```
+
+### Pre-commit setup
+
+Install and run hooks:
+
+```bash
+pre-commit install
+pre-commit run -a
+```
+
+## Build and install
+
+```bash
+cargo build --release
+cargo install --path .
+cargo test
+```
+
+### Create packages
+
+Application must be built and stripped:
+
+```bash
+cargo build --release
+strip -s target/release/zxc
+```
+
+Create packages:
+
+```bash
+cargo deb
+cargo generate-rpm
+cargo aur
+```

src/command_runner.rs

@@ -1,14 +1,14 @@
 use run_script::types::ScriptError::{Description, FsIOError, IOError};
 use run_script::{spawn, IoOptions, ScriptError, ScriptOptions};
-use std::io::{Error, ErrorKind};
+use std::io::Error;
 use std::process::ExitStatus;
 
 /// Convert all errors to `std::io::Error`.
 fn match_error(script_error: ScriptError) -> Error {
     match script_error {
         IOError(io_error) => io_error,
-        FsIOError(fsio_error) => Error::new(ErrorKind::Other, fsio_error.to_string()),
-        Description(description) => Error::new(ErrorKind::Other, description),
+        FsIOError(fsio_error) => Error::other(fsio_error.to_string()),
+        Description(description) => Error::other(description),
     }
 }
 

src/def_file_finder.rs

@@ -26,10 +26,7 @@ fn find_def_file(directory_path: &Path) -> Result<Option<PathBuf>, Error> {
 
     // Disallow multiple found.
     if found_files.len() > 1 {
-        return Err(Error::new(
-            ErrorKind::Other,
-            "Multiple definition files found",
-        ));
+        return Err(Error::other("Multiple definition files found"));
     }
 
     // Check if any found.