Skip to content

Commit

Permalink
update README, remove unneeded notes, add GH Actions section
Browse files Browse the repository at this point in the history
  • Loading branch information
JGreenlee committed Oct 23, 2024
1 parent 4a05a62 commit 4316185
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ This repository uses the [Transcrypt](https://www.transcrypt.org/) library to co

## Setup

Anaconda is required.

```bash
. bin/setup.sh
```
Expand All @@ -23,7 +21,7 @@ Re-run this if you change the dependencies in `environment.yml` or `package.json
## To contribute

1. Make your changes to Python code under the `src` directory.
1. Run `bash bin/compile_to_js.sh` to build the JavaScript. This will produce output JS files in the `emcommon_js` directory. However, `pip install transcrypt` is required.
1. Run `bash bin/compile_to_js.sh` to build the JavaScript. This will produce output JS files in the `emcommon_js` directory.
1. Commit changes from both the `src` and `emcommon_js` directories to your branch.

## Tips for writing code to work in both Python and JavaScript
Expand Down Expand Up @@ -128,3 +126,7 @@ There may be testing scenarios that must significantly diverge between Python an
```bash
. bin/run_jest.sh
```

### GitHub Actions

The unit tests also run via an Actions workflow, which executes both `run_pytest.sh` and `run_jest.sh` on each commit or PR to `master`.

0 comments on commit 4316185

Please sign in to comment.