Skip to content

Commit

Permalink
Readme and more (#515)
Browse files Browse the repository at this point in the history
  • Loading branch information
martinthomson authored Dec 3, 2024
1 parent 2f48195 commit 6f3fb06
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 15 deletions.
7 changes: 5 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
build/
out/
*.sublime-*
*.swp
*~
/.venv/
/build/
/out/
21 changes: 16 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
specs = $(patsubst %.bs,build/%.html,$(wildcard *.bs))
specs := $(patsubst %.bs,build/%.html,$(wildcard *.bs))
VENV := .venv
bikeshed := $(VENV)/bin/bikeshed

.PHONY: all clean
.PHONY: all clean dist-clean
.SUFFIXES: .bs .html

all: $(specs)

clean:
rm -rf build *~
-rm -rf build *~

dist-clean: clean
-rm -rf $(VENV)

build:
mkdir -p build

build/%.html: %.bs Makefile build
bikeshed --die-on=fatal spec $< $@
$(VENV):
python3 -m venv $(VENV)

$(bikeshed): $(VENV)
$(VENV)/bin/pip install bikeshed

build/%.html: %.bs build $(bikeshed)
$(bikeshed) --die-on=fatal spec $< $@
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
design-principles
=================
# Web Platform Design Principles

This is a repository for a (proposed) set of general design principles
A set of design principles to be used when designing web platform technologies. These principles have been collected by the [Technical Architecture Group](https://www.w3.org/2001/tag/) and developed along with the [Ethical Web principles](https://github.com/w3ctag/ethical-web-principles/).

Building
--------

You will need [GNU Make](https://www.gnu.org/software/make/) and [Bikeshed](https://pypi.org/project/bikeshed/).
# Building

With those dependencies, simply invoke this command to build the document:
You will need [GNU Make](https://www.gnu.org/software/make/) and Python 3.

make
With those dependencies, simply invoke `make` to build the document.


# Contributing

Contributions are welcome to anyone who follows [our code of conduct](https://www.w3.org/Consortium/cepc/).

0 comments on commit 6f3fb06

Please sign in to comment.