This repo contains the content of robotcomponents.github.io/RobotComponents-Documentation/. The documentation page is built on Just The Docs.
Pull request are welcome. If you want to build the site yourself, to test your changes before opening a pull request, then please check out the getting started guide below.
-
Install Ruby (Ruby+Devkit 2.6.6-1 (x64)) from here.
-
Open your cmd and type in:
$ gem install jekyll bundler -
Navigate to your project folder and type in for installing the right bundler version:
$ gem install bundler --version '2.0.1' $ bundler -
To start the local server and create some special jekyll files when the _config.yml is changed type in:
$ bundler exec jekyll serve
Now you can open http://localhost:4000/ in your browser and test the documentation.
View the documentation of Just The Docs for usage information.
Robot Components is an open source project initiated by the chair of Experimental and Digital Design and Construction of the University of Kassel. The technical development is executed by the developers and contributors who are listed here.
We forked the theme from Just The Docs. The theme is available as open source under the terms of the MIT License. See below for the license of the content of the documentation website.
Robot Components
Copyright (c) 2018-2023 The Robot Components authors and / or their affiliations
Robot Components is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 3.0 as published by the Free Software Foundation.
Robot Components is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with Robot Components; If not, see http://www.gnu.org/licenses/.
@license LGPL-3.0 https://www.gnu.org/licenses/lgpl-3.0.html
