Skip to content
This repository was archived by the owner on May 18, 2023. It is now read-only.

Commit 5ecf19e

Browse files
committed
Update README.md
1 parent 457aea5 commit 5ecf19e

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,23 @@
22

33
This repository is a simple example of how you might create an express server to use S4TK in any language of your choice. This example server is intended to be run locally, and has two endpoints for converting SimData between XML and binary.
44

5-
To test it out, open this project in any editor of your choice, and run `npm start` to start the server. You can then run `python3 tests/test.py` to run the Python test file. You may need to install the requests package with `pip3 install requests`. You may also test this project with [Postman](https://www.postman.com/).
5+
## Running the project
6+
7+
Open this project in any editor of your choice, and run the following commands.
8+
9+
Install dependencies
10+
```sh
11+
npm i
12+
```
13+
14+
Start the server
15+
```sh
16+
npm start
17+
```
18+
19+
Test with Python
20+
```sh
21+
python3 tests/test.py
22+
```
23+
24+
You may also test this project with [Postman](https://www.postman.com/).

0 commit comments

Comments
 (0)