Skip to content

FreeCAD/DevelopersHandbook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c7db7ce · Apr 4, 2025
Aug 12, 2023
Oct 15, 2023
May 30, 2024
Apr 4, 2025
Jul 2, 2024
Jan 27, 2025
Feb 24, 2025
Jun 1, 2024
Mar 26, 2025
Jan 5, 2024
Sep 19, 2024
Sep 27, 2024
Oct 7, 2024
Jan 5, 2024
Jun 1, 2024
Apr 6, 2023
May 30, 2024
Nov 20, 2024

Repository files navigation

Developers Handbook

This is the repo for the Developers Handbook.

Install and run locally

This handbook uses Jekyll, a static site generator written in Ruby. There are several options for setting up local development. Examples below illustrate the process using Bundler on a Debian-based system, or using a Docker container to keep things separate from the host system. After setup, the handbook will be available at http://127.0.0.1:4000.

Debian-based system setup

Although Jekyll is packaged in Debian, the github-pages gem is not, so Bundler is required to handle dependencies. It is not necessary to apt install jekyll.

Bundler requires ruby-dev and build-essential to build Ruby gem native extensions.

$ sudo apt install ruby-bundler ruby-dev build-essential
$ bundle install
$ bundle exec jekyll serve

Docker container setup

Docker bind mounts the handbook source directory inside the container and marks it as private & unshared with any other container, before calling jekyll serve as in the instructions above.

$ docker run --rm --volume="$PWD:/srv/jekyll:Z" -it jekyll/jekyll jekyll serve

References

About

A handbook about FreeCAD development

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published