You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,18 +5,21 @@
5
5
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.
6
6
7
7
8
-
## OpenSPP
8
+
Browse the published documentation at **https://docs.openspp.org/**.
9
9
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.
11
11
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`.
13
16
14
17
## Contribute
15
18
16
-
-[Contributing to OpenSPP Documentation](https://docs.openspp.org/contributing/index.html)
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