Main Page: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | |||
== Introduction == | |||
This is the documentation wiki of [http://www.labrps.com LabRPS]. There are several ways to use this documentation: by exploring the hubs, by following the manual, or by using the Help menu entries from within LabRPS. This is a work in progress, written by the community of users and developers of LabRPS. If you find information that is wrong or missing, please [[Special:MyLanguage/help_LabRPS|help LabRPS]]! | |||
{{Clear}} | |||
== The hubs == | |||
== | [[Image:Crystal_Clear_app_display.png|64px|left]] [[User_hub|Users hub]]: This page contains documentation useful for LabRPS users in general: a list of all the plugins, detailed instructions on how to install and use the LabRPS application, tutorials, and all you need to get started. | ||
* [https:// | {{Clear}} | ||
[[Image:Crystal Clear app terminal.png|64px|left]] [[Power_users_hub|Power users hub]]: This page gathers documentation for advanced users and people interested in writing c++ codes. There you will also find a repository of plugins, instructions on how to install and use them, and more information about customizing LabRPS to your specific needs. | |||
{{Clear}} | |||
[[Image:Crystal Clear app tutorials.png|64px|left]] [[Developer_hub|Developers hub]]: This section contains material for developers: How to compile LabRPS yourself, how the LabRPS source code is structured, how to navigate the source code, how to develop new plugins. | |||
{{Clear}} | |||
== Get involved == | |||
=== How to participate === | |||
There is plenty to do inside the LabRPS project, if you are interested in helping us. Of course, there are programming tasks for C++ programmers, but there are also many things you can do even if you cannot code, such as | |||
* writing documentation and [[WikiPages|editing the wiki (en)]] | |||
* helping newcomers | |||
* helping with the packaging of the latest release of LabRPS for your favourite operating system | |||
* helping other people around you to discover LabRPS. | |||
=== Source code === | |||
LabRPS can be compiled on all platforms. The source code is [https://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License LGPL]-licensed and hosted on [https://github.com/LabRPS/LabRPS GitHub] and mirrored on [https://gitlab.com/LabRPS/LabRPS GitLab] and [https://codeberg.org/LabRPS/LabRPS CodeBerg]. There are build instructions for [[Compile_on_Windows|Windows]], [[Compile_on_Linux|Linux]] and [[Compile_on_MacOS|MacOS]]. The source code documentation is [http://www.labrps.com/api/ hosted here], generated by [[Doxygen|Doxygen]], and [[Source_documentation|documented on the wiki]]. | |||
=== About the development === | |||
Check the [[Development roadmap|Development roadmap]] for news about what is being planned, the [http://labrps.com/changelog Changelog] and [http://labrps.com/roadmap Roadmap] pages to see the progress towards next release, or the [http://www.ohloh.net/p/labrps Project statistics] for even more information about the LabRPS codebase. All the development communication happens on the [http://labrps.com/boards forum], so be sure to visit it if you are interested in participating. | |||
{{Userdocnavi}} | |||
[[Category:Documentation]] | |||
Revision as of 05:44, 7 August 2022
Introduction
This is the documentation wiki of LabRPS. There are several ways to use this documentation: by exploring the hubs, by following the manual, or by using the Help menu entries from within LabRPS. This is a work in progress, written by the community of users and developers of LabRPS. If you find information that is wrong or missing, please help LabRPS!
The hubs
Users hub: This page contains documentation useful for LabRPS users in general: a list of all the plugins, detailed instructions on how to install and use the LabRPS application, tutorials, and all you need to get started.
Power users hub: This page gathers documentation for advanced users and people interested in writing c++ codes. There you will also find a repository of plugins, instructions on how to install and use them, and more information about customizing LabRPS to your specific needs.
Developers hub: This section contains material for developers: How to compile LabRPS yourself, how the LabRPS source code is structured, how to navigate the source code, how to develop new plugins.
Get involved
How to participate
There is plenty to do inside the LabRPS project, if you are interested in helping us. Of course, there are programming tasks for C++ programmers, but there are also many things you can do even if you cannot code, such as
- writing documentation and editing the wiki (en)
- helping newcomers
- helping with the packaging of the latest release of LabRPS for your favourite operating system
- helping other people around you to discover LabRPS.
Source code
LabRPS can be compiled on all platforms. The source code is LGPL-licensed and hosted on GitHub and mirrored on GitLab and CodeBerg. There are build instructions for Windows, Linux and MacOS. The source code documentation is hosted here, generated by Doxygen, and documented on the wiki.
About the development
Check the Development roadmap for news about what is being planned, the Changelog and Roadmap pages to see the progress towards next release, or the Project statistics for even more information about the LabRPS codebase. All the development communication happens on the forum, so be sure to visit it if you are interested in participating.
User documentation
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, AppImage
- Basics: About LabRPS, Interface, RPS Objects, Object name, Preferences, Workbenches, Document structure, Properties, Help LabRPS, Donate
- Hubs: User hub, Power users hub, Developer hub