From d06bc007916144bb74ac6f4f95024d5ef6ed0532 Mon Sep 17 00:00:00 2001 From: Frank Vega Date: Sun, 29 Dec 2024 07:41:07 -0500 Subject: [PATCH] Updated documentation for pip deployment. --- README.md | 8 ++++---- docs/index.html | 8 ++++---- setup.py | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5e8a7cc..d996899 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ pip install capablanca Run the following command to solve a sample `.cnf` file named `file.cnf` included with Capablanca's benchmarks: ``` - python -m jaque -i benchmarks/simple/file.cnf + jaque -i benchmarks/simple/file.cnf ``` Capablanca supports compressed `.cnf` files, including `.xz`, `.lzma`, `.bz2`, and `.bzip2` formats. @@ -137,7 +137,7 @@ You can then use the `jaque` command to run the sample benchmarks. For example, - Test the satisfiable formula `aim-50-1_6-yes1-1.cnf`: ``` - python -m jaque -i benchmarks/file-dimacs-aim/aim-50-1_6-yes1-1.cnf + jaque -i benchmarks/file-dimacs-aim/aim-50-1_6-yes1-1.cnf s SATISFIABLE v 2 3 7 8 9 14 17 18 19 20 21 22 23 24 26 27 28 30 31 35 36 38 39 40 41 42 43 46 48 -50 -49 -47 -45 -44 -37 -34 -33 -32 -29 -25 -16 -15 -13 -12 -11 -10 -6 -5 -4 -1 0 ``` @@ -147,7 +147,7 @@ A satisfiable formula means there exists a truth assignment that makes the formu - Test the unsatisfiable formula `aim-50-1_6-no-1.cnf`: ``` - python -m jaque -i benchmarks/file-dimacs-aim/aim-50-1_6-no-1.cnf + jaque -i benchmarks/file-dimacs-aim/aim-50-1_6-no-1.cnf s UNSATISFIABLE ``` @@ -158,7 +158,7 @@ running these sample benchmarks, you can verify that Capablanca is functioning c To view the available command-line options for the `jaque` command, use the following command in your terminal or command prompt: ``` -python -m jaque -h +jaque -h ``` This will display the help message, which provides information about the available options and their usage: diff --git a/docs/index.html b/docs/index.html index ddf10e2..40dae65 100644 --- a/docs/index.html +++ b/docs/index.html @@ -224,7 +224,7 @@

Running the SAT Solver with Capablanca

Run the following command to solve a sample .cnf file named file.cnf included with Capablanca's benchmarks:

-
python -m jaque -i benchmarks/simple/file.cnf
+        
jaque -i benchmarks/simple/file.cnf
 
@@ -296,7 +296,7 @@

SAT Benchmarks and Testing

  • Test the satisfiable formula aim-50-1_6-yes1-1.cnf:

    -
    python -m jaque -i benchmarks/file-dimacs-aim/aim-50-1_6-yes1-1.cnf
    +        
    jaque -i benchmarks/file-dimacs-aim/aim-50-1_6-yes1-1.cnf
     s SATISFIABLE
     v 2 3 7 8 9 14 17 18 19 20 21 22 23 24 26 27 28 30 31 35 36 38 39 40 41 42 43 46 48 -50 -49 -47 -45 -44 -37 -34 -33 -32 -29 -25 -16 -15 -13 -12 -11 -10 -6 -5 -4 -1 0
     
    @@ -310,7 +310,7 @@

    SAT Benchmarks and Testing

    • Test the unsatisfiable formula aim-50-1_6-no-1.cnf:

      -
      python -m jaque -i benchmarks/file-dimacs-aim/aim-50-1_6-no-1.cnf
      +        
      jaque -i benchmarks/file-dimacs-aim/aim-50-1_6-no-1.cnf
       s UNSATISFIABLE
       
    • @@ -325,7 +325,7 @@

      Command-Line Options

      jaque command, use the following command in your terminal or command prompt:

      -
      python -m jaque -h
      +    
      jaque -h
       

      This will display the help message, which provides information about the diff --git a/setup.py b/setup.py index 80bece1..139e15e 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ import setuptools -VERSION = "1.0" +VERSION = "1.1" NAME = "capablanca"