Skip to content

Commit d5832bc

Browse files
authored
Merge pull request #119 from OpenSPP/readme-update
Update README: fix links, build note, license attribution
2 parents 6a5d1a0 + fddb674 commit d5832bc

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@
55
OpenSPP is an open-source project that aims to streamline the management of social protection programs. It can be used on its own or in conjunction with other services.
66

77

8-
## OpenSPP
8+
Browse the published documentation at **https://docs.openspp.org/**.
99

10-
Browse the OpenSPP Documentation at https://docs.openspp.org/.
10+
Note: the latest documentation may not yet be merged to this [main](https://github.com/OpenSPP/documentation/tree/main) repository.
1111

12-
Active development on the OpenSPP Documentation takes place on the branch [`main`](https://github.com/openspp/documentation/).
12+
## Building the documentation
13+
14+
Python 3.11 is required to build the documentation. If you are using pyenv, create a `.python-version` to set the version before running any `make` commands.
15+
After installing library dependencies - see [docs/contributing/setup-build.md](docs/contributing/setup-build.md) for details - build the documentation using `make html` or `make livehtml`.
1316

1417
## Contribute
1518

16-
- [Contributing to OpenSPP Documentation](https://docs.openspp.org/contributing/index.html)
17-
- [Issue Tracker](https://github.com/openspp/documentation/issues)
18-
- [Source Code](https://github.com/openspp/documentation)
19+
- [How to contribute to the project](https://docs.openspp.org/community_and_support/how_to_contribute_to_the_project.html) — code, docs, and issues
20+
- [Issue tracker](https://github.com/OpenSPP/documentation/issues)
21+
- [Source code](https://github.com/OpenSPP/documentation)
1922

2023
## License
2124

22-
The project is licensed under the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/) by [Newlogic](https://newlogic.com).
25+
The documentation is licensed under the [Creative Commons Attribution 4.0 International License (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/). OpenSPP and this documentation are maintained by the OpenSPP community and ACN (Association pour la Coopération Numérique), with contributions from others.

0 commit comments

Comments
 (0)