Skip to content

Commit

Permalink
{doc} Final doc change for 0.6.0
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
asmaloney committed May 31, 2022
1 parent d7c6cc1 commit ce2b288
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 12 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [0.6.0] (in progress)
## [0.6.0](https://github.com/asmaloney/gactar/releases/tag/v0.6.0) - 2022-05-31

### Added

Expand All @@ -26,6 +26,10 @@ All notable changes to this project will be documented in this file. The format
- Turn on **pyactr**'s _subsymbolic_ option to be in line with **vanilla**
- Replaced "anonymous variable" (`?`) with a wildcard character (`*`). ([#123](https://github.com/asmaloney/gactar/pull/123))

### Fixed

- In the web UI, only use syntax highlighting on variables if they are within square brackets.

## [0.5.0](https://github.com/asmaloney/gactar/releases/tag/v0.5.0) - 2022-05-26

### Added
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,21 +240,21 @@ To run it using methods 2-4, here are the command line options:
gactar [OPTIONS] [FILES...]
```

**--debug, -d**: turn on debugging output
**-debug, -d**: turn on debugging output

**--ebnf**: output amod EBNF to stdout and quit
**-ebnf**: output amod EBNF to stdout and quit

**--framework, -f** [string]: add framework - valid frameworks: all, ccm, pyactr, vanilla (default: `all`)
**-framework, -f** [string]: add framework - valid frameworks: all, ccm, pyactr, vanilla (default: `all`)

**--interactive, -i**: run an interactive shell
**-interactive, -i**: run an interactive shell

**--port, -p** [number]: port to run the web server on (default: `8181`)
**-port, -p** [number]: port to run the web server on (default: `8181`)

**--run, -r**: run the models after generating the code
**-run, -r**: run the models after generating the code

**--temp** [string]: directory for generated files (it will be created if it does not exist) (default: `./gactar-temp`)
**-temp** [string]: directory for generated files (it will be created if it does not exist) (default: `./gactar-temp`)

**--web, -w**: start a web server to run in a browser
**-web, -w**: start a web server to run in a browser

### 1. Run With Visual Studio Code

Expand Down Expand Up @@ -319,7 +319,7 @@ ccm: Using Python 3.9.13 from /path/to/gactar/env/bin/python3
- written to gactar-temp/ccm_count.py
```

You can choose which frameworks to use with `--framework` or `-f` like this:
You can choose which frameworks to use with `-framework` or `-f` like this:

```
(env)$ ./gactar -f ccm -f vanilla examples/count.amod
Expand All @@ -334,7 +334,7 @@ vanilla: Using SBCL 1.2.11 from /path/to/gactar/env/bin/sbcl
- written to gactar-temp/vanilla_count.lisp
```

You can write the files to a different location using `--temp`:
You can write the files to a different location using `-temp`:

```
(env)$ ./gactar -f ccm -temp intermediate examples/count.amod
Expand All @@ -346,7 +346,7 @@ ccm: Using Python 3.9.13 from /path/to/gactar/env/bin/python3
- written to intermediate/ccm_count.py
```

You can also choose to run the models using `--run` or `-r`:
You can also choose to run the models using `-run` or `-r`:

```
(env)$ ./gactar -f ccm -temp intermediate -r examples/count.amod
Expand Down
Binary file modified images/vscode-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ce2b288

Please sign in to comment.