Skip to content

Commit

Permalink
update README and make new release
Browse files Browse the repository at this point in the history
  • Loading branch information
francescofuggitti committed Nov 3, 2024
1 parent 61ffd50 commit 011d9d9
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 6 deletions.
6 changes: 6 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# History

## 0.0.4 (2024-11-03)
- change build mode with Pipenv removal
- add feature to build transition actions without disjunctive preconditions
- fix bug in parser for types requirement and empty actions
- remove online version at [fond4ltlf](https://fond4ltlf.herokuapp.com/)

## 0.0.3 (2021-06-17)
- add references
- change docs website
Expand Down
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,22 +58,46 @@ cd FOND4LTLf
pip install .
```

## How To Use
## Usage

Use the command line interface:
The output of the CLI is the following:

```bash
fond4ltlf -d <path/to/domain.pddl> -p <path/to/problem.pddl> -g "formula"
user:~$ fond4ltlf --help
Usage: fond4ltlf [OPTIONS]

From FOND Planning for LTLf/PLTLf Goals to Classical FOND Planning.

Options:
-d, --in-domain PATH Path to PDDL domain file. [required]
-p, --in-problem PATH Path to PDDL problem file. [required]
-g, --goal TEXT LTLf or PLTLf goal formula.
-outd, --out-domain FILE Path to PDDL file to store the new domain.
-outp, --out-problem FILE Path to PDDL file to store the new problem.
-n, --no-disj-preconds No disjunctive preconditions.
--help Show this message and exit.
```

You can also specify custom output paths for the new domain and the new problem using `--out-domain` or `-outd`
and `--out-problem` or `-outp`.
For instance, you can call `FOND4LTLf` as follows:

```bash
fond4ltlf -d <path/to/domain.pddl> -p <path/to/problem.pddl> -g "formula"
```

## Features

* Syntax and parsing support FOND Planning in PDDL
* Compilation of Deterministic Finite-state Automaton into PDDL

## Development

Contributions are welcome! Here's how to set up the development environment:
- set up your preferred virtualenv environment
- clone the repo: `git clone https://github.com/IBM/nl2ltl.git && cd nl2ltl`
- install dependencies: `pip install -e .`
- install dev dependencies: `pip install -e ".[dev]"`
- install pre-commit: `pre-commit install`

## Tests

To run tests: `tox`
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "fond4ltlf"
version = "0.0.3"
version = "0.0.4"
license = {file = "LICENSE"}
authors = [
{ name = "Francesco Fuggitti", email = "[email protected]" },
Expand Down

0 comments on commit 011d9d9

Please sign in to comment.