Skip to content

Commit

Permalink
Updated documentation for pip deployment.
Browse files Browse the repository at this point in the history
  • Loading branch information
frankvegadelgado committed Dec 29, 2024
1 parent 0da68c3 commit d06bc00
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
```
Expand All @@ -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
```

Expand All @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ <h2>Running the SAT Solver with Capablanca</h2>
Run the following command to solve a sample <code>.cnf</code> file
named <code>file.cnf</code> included with Capablanca's benchmarks:
</p>
<pre><code>python -m jaque -i benchmarks/simple/file.cnf
<pre><code>jaque -i benchmarks/simple/file.cnf
</code></pre>
</li>
</ol>
Expand Down Expand Up @@ -296,7 +296,7 @@ <h2>SAT Benchmarks and Testing</h2>
<ul>
<li>
<p>Test the satisfiable formula <code>aim-50-1_6-yes1-1.cnf</code>:</p>
<pre><code>python -m jaque -i benchmarks/file-dimacs-aim/aim-50-1_6-yes1-1.cnf
<pre><code>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
</code></pre>
Expand All @@ -310,7 +310,7 @@ <h2>SAT Benchmarks and Testing</h2>
<ul>
<li>
<p>Test the unsatisfiable formula <code>aim-50-1_6-no-1.cnf</code>:</p>
<pre><code>python -m jaque -i benchmarks/file-dimacs-aim/aim-50-1_6-no-1.cnf
<pre><code>jaque -i benchmarks/file-dimacs-aim/aim-50-1_6-no-1.cnf
s UNSATISFIABLE
</code></pre>
</li>
Expand All @@ -325,7 +325,7 @@ <h2>Command-Line Options</h2>
<code>jaque</code> command, use the following command in your terminal or
command prompt:
</p>
<pre><code>python -m jaque -h
<pre><code>jaque -h
</code></pre>
<p>
This will display the help message, which provides information about the
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import setuptools

VERSION = "1.0"
VERSION = "1.1"

NAME = "capablanca"

Expand Down

0 comments on commit d06bc00

Please sign in to comment.