UsingBikeshed

Installing and using bikeshed

If you can install bikeshed locally, you should do so since it makes some things more convenient. Follow the instructions for a local install.

If you can't (or it doesn't work) or just don't need a local install, you can still use the network version to generate the HTML.

Current Issues

The file expected-errs.txt lists errors which are expected and ignored during spec generation, such as errors generated due to issues in Bikeshed.

If the expected errors change, which can happen if a new version of Bikeshed changes the format of the error messages, the following procedure can be used to update them:

• run ./compile.sh -K (capital K, this will keep the file actual-err.txt)
• copy ./actual-err.txt to expected-err.txt
• commit the result and push to the main branch