Skip to content

Commit

Permalink
README: Added instructions on updating submodule
Browse files Browse the repository at this point in the history
  • Loading branch information
AesaraB committed Mar 12, 2024
1 parent 4bc9e4e commit c1719e6
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,23 @@ is hosted [here][website-theme].
[hugo]: https://gohugo.io
[sass]: https://sass-lang.com/dart-sass
[github]: https://github.com/mypaint/website
[github]: https://github.com/mypaint/website-theme
[website-theme]: https://github.com/mypaint/website-theme

# Contributing
To build this repository:
1. Install hugo-extended, dart sass, and [git-lfs](https://git-lfs.com/)
1. Install [hugo-extended][hugo-release], [dart sass][sass-release], and [git-lfs](https://git-lfs.com/)
2. Clone this repo
3. Run ``git submodule update --init``
4. Run ``hugo`` or ``hugo server``

[hugo-release]: https://github.com/gohugoio/hugo/releases
[sass-release]: https://github.com/sass/dart-sass/releases

## Update submodules
When [website-theme][website-theme] or other submodules are updated, use
``git submodule update --recursive --remote`` to reflect the changes in
your development environment.

## Adding content
Page content is stored in the [pages](/pages/) directory. Pages are written in
[markdown][hugo-learn-md] and [extended][hugo-content] by Hugo.
Expand Down
2 changes: 1 addition & 1 deletion themes/mypaint

0 comments on commit c1719e6

Please sign in to comment.