bplrfe / solvespace-web Goto Github PK

View Code? Open in Web Editor NEW

solvespace.com website

License: Other

ApacheConf 0.13% Perl 88.76% Makefile 0.45% Perl 6 8.40% CSS 1.35% JavaScript 0.40% Shell 0.50%

solvespace-web's Introduction

SolveSpace's website

This repository contains the source code of the official website of SolveSpace, a parametric 2d/3d CAD.

Prerequisites

The templating engine that generates this website is written in Perl and requires the GD module.

Linux

On Debian, Ubuntu, and compatible distributions the dependencies can be installed with:

apt-get install perl-base libgd-gd2-perl

macOS

When using Homebrew, the dependencies can be installed with:

brew install perl libgd
cpan install gd

Windows

On Windows 10, the dependencies can be installed using the Windows Subsystem for Linux, by first installing WSL and then following the steps for Linux.

On any version of Windows, the dependencies can be installed using Cygwin:

git
make
perl, perl-GD

Workflow

Before you start, fork the solvespace-web repository and clone it into any convenient directory:

git clone [email protected]:USERNAME/solvespace-web

Then, verify that the prerequisites are installed correctly by running make. If this command succeeds, open the html/index.html file in your browser.

You can modify the website as follows:

Change a .pl file to modify a page, or add an asset to pics, vids or dl;
(Re)generate HTML for every page and copy assets by invoking make;
Verify that the change is correct;
Commit the change and send a pull request.