demostf/tf-demos-viewer
1
0
Fork 0
mirror of https://codeberg.org/demostf/tf-demos-viewer.git synced 2026-06-03 10:04:12 +02:00
Code Issues Projects Releases Packages Wiki Activity

readme

Browse source
This commit is contained in:
Robin Appelman 2022-08-27 14:51:31 +02:00
commit e34010e64f
1 changed files with 1 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

49
README.md
View file

@ -1,48 +1 @@
## How to install
```sh
npm install
```
## How to run in debug mode
```sh
# Builds the project and opens it in a new browser tab. Auto-reloads when the project changes.
npm start
```
## How to build in release mode
```sh
# Builds the project and places it into the `dist` folder.
npm run build
```
## How to run unit tests
```sh
# Runs tests in Firefox
npm test -- --firefox
# Runs tests in Chrome
npm test -- --chrome
# Runs tests in Safari
npm test -- --safari
```
## What does each file do?
* `Cargo.toml` contains the standard Rust metadata. You put your Rust dependencies in here. You must change this file with your details (name, description, version, authors, categories)
* `package.json` contains the standard npm metadata. You put your JavaScript dependencies in here. You must change this file with your details (author, name, version)
* `webpack.config.js` contains the Webpack configuration. You shouldn't need to change this, unless you have very special needs.
* The `js` folder contains your JavaScript code (`test.ts` is used to hook everything into Webpack, you don't need to change it).
* The `src` folder contains your Rust code.
* The `static` folder contains any files that you want copied as-is into the final build. It contains an `index.html` file which loads the `test.ts` file.
* The `tests` folder contains your Rust unit tests.
JS bindings for demo parser