Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-28 14:04:10 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Mention that 'npm i' will install git submodules

Browse source
This commit is contained in:
Andrew Morgan 2022-11-08 16:21:08 +00:00
parent a101159d96
commit 007bc8e0b9
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -65,7 +65,8 @@ place after an MSC has been accepted, not as part of a proposal itself.
Alternatively, use the Docker image at Alternatively, use the Docker image at
https://hub.docker.com/r/klakegg/hugo/. (The "extended edition" is required https://hub.docker.com/r/klakegg/hugo/. (The "extended edition" is required
to process the SCSS.) to process the SCSS.)
2. Run `npm i` to install the dependencies. Note that this will require NodeJS to be installed. 2. Run `npm i` to install the dependencies and fetch the docsy git submodule.
Note that this will require NodeJS to be installed.
3. Run `npm run get-proposals` to seed proposal data. This is merely for populating the content of the "Spec Change Proposals" 3. Run `npm run get-proposals` to seed proposal data. This is merely for populating the content of the "Spec Change Proposals"
page and is not required. page and is not required.
4. Run `hugo serve` (or `docker run --rm -it -v $(pwd):/src -p 1313:1313 4. Run `hugo serve` (or `docker run --rm -it -v $(pwd):/src -p 1313:1313