updated doc & metainformation

Cargo.toml

@@ -1,6 +1,13 @@
 [package]
 name = "decdnnf_rs"
+authors = ["Jean-Marie Lagniez <[email protected]>", "Emmanuel Lonca <[email protected]>"]
+license = "GPL-3.0-or-later"
 version = "0.1.0"
+description = "A library for Decision-DNNFs."
+categories = ["command-line-utilities", "science"]
+keywords = ["decision", "DNNF", "model", "counting", "enumeration"]
+repository = "https://github.com/crillab/decdnnf_rs"
+rust-version = "1.72.1"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -9,7 +16,7 @@ edition = "2021"
 missing_docs = "warn"
 
 [lints.clippy]
-pedantic = "warn"
+pedantic = { level = "warn", priority = -1 }
 module_name_repetitions = "allow"
 
 [lib]

README.md

@@ -1,8 +1,8 @@
 # Decdnnf-rs
 
-Rust tools for Decision-DNNF formulas.
+Rust tools for Decision-DNNF formulas, including translation, model counting and model enumeration.
 
-## Compiling/installing decdnnf-rs
+## Compiling/installing decdnnf-rs from sources
 
 Decdnnf-rs requires a recent version of the Rust toolchain (>= 1.72.1).
 See [rust-lang.org](https://www.rust-lang.org/tools/install) for more information on how to install Rust.
@@ -24,8 +24,10 @@ In the same way, you can obtain the list of expected and optional arguments by a
 decdnnf_rs model-counting -h
 ```
 
-The `model-counting` and the `translation` commands share most of their options, like input file and logging level.
-Another one of interest is `--n-vars`. Since the output format of d4 does not provide the number of variables of the problems, it cannot be deduced if it is more important than the highest variable index in use. Setting `--n-vars` allows to override the number of variables returned by the parser, which is set to the highest variable index.
+Some options are common to most commands, like the ones dedicated to input file and logging level.
+Another one of interest is `--n-vars`.
+Since the output format of d4 (which is the default input format of decdnnf_rs) does not provide the number of variables of the problems, this number cannot be deduced if it is more important than the highest variable index in use.
+Setting `--n-vars` allows to override the number of variables returned by the parser, which is set to the highest variable index.
 
 ## Translate a d4 Decision-DNNF into a c2d Decision-DNNF
 
@@ -50,7 +52,8 @@ Use the `model-enumeration` command:
 ```bash
 decdnnf_rs model-enumeration -i instance.nnf
 ```
-This commands admits multiple options allowing to set the number of variables (in case it is higher than the highest index in the input formula), use a compact output or use an enumeration algorithm based on a decision tree. Run `decdnnf_rs model-enumeration -h` for more information.
+This commands admits multiple options allowing to set the number of variables (in case it is higher than the highest index in the input formula), use a compact output or use an enumeration algorithm based on a decision tree.
+Run `decdnnf_rs model-enumeration -h` for more information.
 
 ## License
 

src/lib.rs

@@ -1,4 +1,4 @@
-//! A library used to handle Decision-DNNF formulas.
+#![doc = include_str!("../README.md")]
 
 mod algorithms;
 pub use algorithms::CheckingVisitor;