Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build instructions #36

Merged
merged 2 commits into from
Jan 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions BUILDING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# How to build this spec

This repository uses the [ReSpec toolchain](https://respec.org/docs/). Please find below a quick getting started cheatsheet using the [command line](https://respec.org/docs/#using-command-line) tools.

Setup `respec` for multiple use:
```
$ npm install --global respec
```
Update your environment with the following variables:
```
export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=1
export PUPPETEER_EXECUTABLE_PATH="/usr/bin/google-chrome"
# replace "/usr/bin/google-chrome" with path to Chrome executable on your system.
# On MacOS, it's generally:
# "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
```
This spec uses the `data-include` attribute. For `respec` to work locally, the content MUST be served by a web server. One easy way to achive that is to run one from the project directory:
```
# Install a local HTTP server if not already installed (one time)
$ npm install -g http-server

# Start the server in your project directory
$ http-server
```

Note that the server starts on port 8080. Now you can run `respec` to generate the spec [`index.html`](http://localhost:8080/index.html) in the project root and test changes.
```
$ respec --src http://localhost:8080/spec/index.html --out index.html
```

33 changes: 0 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Specification 'lws-ucs'

This is the repository for lws-ucs. You're welcome to contribute! Let's make the Web rock our socks
Expand All @@ -13,35 +12,3 @@ LWS user stories are classified under the following categories:
* Technical: related to infrastructure tasks (e.g., "As a Service Provider, I want the ability to archive LWS storages").
* Spike: used to explore or research an unknown aspect of the project (e.g., "Research what Identity System supports delegation.").

## How to build this spec

This repository uses the [ReSpec toolchain](https://respec.org/docs/). Please find below a quick getting started cheatsheet using the [command line](https://respec.org/docs/#using-command-line) tools.

Setup `respec` for multiple use:
```
$ npm install --global respec
```
Update your environment with the following variables:
```
export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=1
export PUPPETEER_EXECUTABLE_PATH="/usr/bin/google-chrome"
# replace "/usr/bin/google-chrome" with path to Chrome executable on your system.
# On MacOS, it's generally:
# "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
```
This spec uses the `data-include` attribute. For `respec` to work locally, the content MUST be served by a web server. One easy way to achive that is to run one from the project directory:
```
# Install a local HTTP server if not already installed (one time)
$ npm install -g http-server

# Start the server in your project directory
$ http-server
Starting up http-server, serving ./

http-server version: 14.1.1
```

Note that the server starts on port 8080. Now you can run `respec` to generate the spec [`index.html`](http://localhost:8080/index.html) in the project root and test changes.
```
$ respec --src http://localhost:8080/spec/index.html --out index.html
```
1 change: 1 addition & 0 deletions spec/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
specStatus: "ED",
shortName: "lws-ucs",
copyrightStart: "2024",
github: "w3c/lws-ucs",
// previousPublishDate: "N/A",
editors: [
{ name: "Pierre-Antoine Champin" },
Expand Down
Loading