Commit 796d24db authored by David Boddie's avatar David Boddie 💬
Browse files

Add some information about reuse of the submodule

parent a827c8bd
## Source code for docs.puri.sm/Librem_5
# Librem 5 User Documentation
This repository is used as a submodule for two other repositories:
This repository contains Librem 5 user documentation and is used as a submodule
for two other repositories:
#. The repository containing the source code for the docs.puri.sm site
#. The repository used to create a standalone documentation package.
#. The [repository](https://source.puri.sm/Librem5/librem5-user-docs) containing the documentation for the docs.puri.sm site
#. The [repository](https://source.puri.sm/Purism/docs.puri.sm) used to create a standalone documentation package
## Building
To build:
```
make clean html
```
## Updating other repositories
After updating this repository, you need to update the repositories that reuse
this content: the [Librem 5 User Guide](https://source.puri.sm/Librem5/librem5-user-docs)
and [online documentation](https://source.puri.sm/Purism/docs.puri.sm)
repositories.
Generally, this will happen automatically when building either of these with
`make` with the `update` rule:
```
make update html
```
Any changes to the submodule will need to be committed to each repository.
## Copyright and License Information
Copyright: Copyright (C) 2019 Purism SPC
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment