Update README to remove the examples using '--refresh'

This commit is contained in:
Zoé Cassiopée Gauthier 2024-04-05 22:17:04 -04:00
parent c67a69b3d0
commit 405173d6cd

View File

@ -10,20 +10,12 @@ pip install -e .
## Usage
To run the simulations, choose your parameters such as attacker type, attacker level, and wether Party Power is active.
Try to fill the stored results database with any of the following:
To run the simulations, choose your parameters such as attacker type, attacker level, and whether Party Power is active.
Display the average scaled estimators for attackers of the given type:
```console
ase-cli --refresh POKEMON_TYPE_GRASS # Grass attackers. Defaults to level 40 and no Party Power.
ase-cli --refresh --level 30 POKEMON_TYPE_GRASS # Level 30 Grass attackers, no Party Power.
ase-cli --refresh --party 2 POKEMON_TYPE_GRASS # Level 40 Grass attackers, Party Power with two trainers.
ase-cli --refresh POKEMON_TYPE_DARK POKEMON_TYPE_GHOST # Combined Dark and Ghost attackers.
```
Once the database contains the desired simulation results, display the average scaled estimators for attackers of the
given type:
```console
ase-cli POKEMON_TYPE_GRASS
ase-cli --level 30 POKEMON_TYPE_GRASS
ase-cli POKEMON_TYPE_GRASS # Grass attackers. Defaults to level 40 and no Party Power.
ase-cli --level 30 POKEMON_TYPE_GRASS # Level 30 Grass attackers, no Party Power.
ase-cli --party 2 POKEMON_TYPE_GRASS # Level 40 Grass attackers, Party Power with two trainers.
ase-cli POKEMON_TYPE_DARK POKEMON_TYPE_GHOST # Combined Dark and Ghost attackers.
```