Skip to content

Commit

Permalink
obsolete readmes removed, serve example index.html from root
Browse files Browse the repository at this point in the history
  • Loading branch information
milyin committed Jan 22, 2025
1 parent ff16abb commit 493259b
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 218 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,4 +176,16 @@ The following examples are available:
yarn start chat
```

The browser window with chat interface should open. Open another one with same address, press "Connect" buttons in both and see how they interact.
The browser window on [localhost:8080](http://127.0.0.1:8080/index.html) with chat interface should open. Open another one with same address, press "Connect" buttons in both and see how do they interact.

### Generating Documentation

1. Make sure that the [typedoc](https://typedoc.org/) dependency is installed.

2. Navigate to the directory `zenoh-ts`

3. Run the commands:

```bash
npx typedoc src/index.ts
```
99 changes: 0 additions & 99 deletions zenoh-ts/README.md

This file was deleted.

27 changes: 0 additions & 27 deletions zenoh-ts/examples/chat/README.md

This file was deleted.

2 changes: 1 addition & 1 deletion zenoh-ts/examples/chat/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"clean": "rm -rf ./node_modules ./dist ./esm",
"build": "rm -rf dist && mkdir dist && webpack --config webpack.config.js && cp assets/* dist/",
"_build": "sh -c '[ ! -d \"node_modules\" ] || [ ! -d \"dist\" ] && yarn clean && yarn install && yarn build || true'",
"start": "sh -c 'yarn _build && http-server ../.. -c-1 -o examples/chat/dist/index.html'"
"start": "sh -c 'yarn _build && http-server dist -c-1 -o index.html'"
},
"devDependencies": {
"http-server": "^14.1.1",
Expand Down
90 changes: 0 additions & 90 deletions zenoh-ts/examples/deno/README.md

This file was deleted.

0 comments on commit 493259b

Please sign in to comment.