diff options
Diffstat (limited to 'pw_web/log-viewer/README.md')
| -rw-r--r-- | pw_web/log-viewer/README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/pw_web/log-viewer/README.md b/pw_web/log-viewer/README.md new file mode 100644 index 000000000..10862ee77 --- /dev/null +++ b/pw_web/log-viewer/README.md @@ -0,0 +1,52 @@ +# Log Viewer + +An embeddable log-viewing web component that is customizable and extensible for use in various developer contexts. + +## Installation + +1. Clone the main Pigweed repository: + +``` +git clone https://pigweed.googlesource.com/pigweed/pigweed +``` + +2. Navigate to the project directory: + +``` +cd pigweed +``` + +3. Install the necessary dependencies: + +``` +source bootstrap.sh +``` + +## Build + +1. Navigate to the project directory: + +``` +cd pigweed/pigweed_web/log-viewer +``` + + +2. run the following command at the root of the project: + +``` +npm run build +``` + +This will generate the compiled files used in the application. + +## Development Mode + +To run the application in development mode, use the following command: + +``` +npm run dev -- --host +``` + +This will start the development server and launch the application. The `--host` flag is optional and can be used to specify the host address. + +## Usage
\ No newline at end of file |