Skip to content

Commit

Permalink
more format cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
anonhostpi committed Sep 3, 2024
1 parent 97d1dd9 commit 469d2c3
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,19 +70,6 @@ npm run test

Both the build and test build will use webpack to bundle the library for the browser.

### Building the Docs Locally

To get the full set of docs locally, run either:
- `npm run docs`: to build the typedoc documentation (./wiki)
- `npm run test:pub`: to build the typedoc documentation and run docusaurus:serve (view the docs from your browser).
- _also runs some minor cleanup work before building with docusaurus_

The full set of docs does not need to be built locally to be used or read.
- The typedocs are sourced from the comments in the ./src files
- The project docs are sourced from ./docs.

There are no other documentation sources in this repo other than this README and the LICENSE.

### Entry Points

The entry points are as follows:
Expand All @@ -94,4 +81,17 @@ The entry points are as follows:
- a copy of DBPF.web.js is also copied to `test/serve` and is automatically loaded by the test environment
- Source files:
- `src/DBPF.ts` - The main library
- `src/test.web.ts` - The script used by the interactive test environment
- `src/test.web.ts` - The script used by the interactive test environment

## Building the Docs Locally

To get the full set of docs locally, run either:
- `npm run docs`: to build the typedoc documentation (./wiki)
- `npm run test:pub`: to build the typedoc documentation and run docusaurus:serve (view the docs from your browser).
- _also runs some minor cleanup work before building with docusaurus_

The full set of docs does not need to be built locally to be used or read.
- The typedocs are sourced from the comments in the ./src files
- The project docs are sourced from ./docs.

There are no other documentation sources in this repo other than this README and the LICENSE.

0 comments on commit 469d2c3

Please sign in to comment.