Skip to content

Commit

Permalink
updating wording
Browse files Browse the repository at this point in the history
  • Loading branch information
robinsteuteville committed May 28, 2024
1 parent d2e0cdc commit 81e78eb
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,12 @@ Developers might want to install the code in place so that FASTSim files can be

## Usage

To see and run examples, download the FASTSim demo files using the function `copy_demo_files()` from `fastsim.utils`. This function downloads demo files into a specified local directory. WARNING: If you download the demo files to a location where files of the same name already exist, the original files will be overwritten.
To see and run examples, download the FASTSim demo files using the following code (with your Python environment activated and FASTSim installed):
```python
from fastsim import utils
utils.copy_demo_files()
```
This code downloads demo files into a specified local directory (if no directory is specified, it will create a `\demos` folder in the current working directory). WARNING: If you download the demo files to a location where files of the same name already exist, the original files will be overwritten.

## Adding FASTSim as a Dependency in Rust

Expand Down

0 comments on commit 81e78eb

Please sign in to comment.