Home

23/8/2017: The content of this wiki has now been fully migrated to the documentation at http://pyrpl.rtfd.io. If you have something to document, you should rather modify the documentation in the docs-folder of the repo than the files here, since it will become impossible to track wiki changes in the future.

---

old wiki

Welcome to the pyrpl wiki!

Let's try to put the developer info, such as explanations on how the code is structured etc., into this wiki instead of the issues section. That way, the info will survive after the issues have been closed!

The page name should start with the category of the provided information, which is currently one of

• API - specifies the application programming interface, used for agreeing on an API before actual coding. These pages are often outdated with respect to documentation in the code, but we keep them since they conserve the historical discussions and often reasons for certain implementation decisions.
• Code - details of the code implementation, including algorithms, tricks, gotchas. Again, these pages are rather used for discussions before actual coding and only intended as supplementary information on top of the commented code.
• Installation - installation instructions for various parts. Should be up-to-date, since it is often linked to from the documentation!
• Packaging - instructions on how to compile code/documentation/executables/distributions for the end user. Always make/update these pages when you do perform of these actions, please!