Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Sculpin — Static Site Generator
tree: a8d21372f8

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
src/sculpin
tests
.gitignore
.travis.yml
LICENSE
README.md
build.properties.dist
build.xml
composer.json
composer.lock
phpunit.xml.dist

README.md

Sculpin - Static Site Generator

Sculpin is a static site generator written in PHP. Visit getsculpin.com for more information.

Requirements

  • PHP: >=5.3.2

Getting Started

Clone the official repository. Or fork and clone your fork. Your call.

git clone https://github.com/sculpin/sculpin.git

Dependencies are managed by the most excellent Composer. From inside your freshly cloned Sculpin, run the following commands to get Composer and install Sculpin's dependencies.

wget http://getcomposer.org/composer.phar
php composer.phar install

For development, either get used to typing /path/to/sculpin/bin/sculpin or create an alias. For example:

alias sculpin=~/workspaces/sculpin/bin/sculpin

To get started quickly, create a new directory for your Sculpin project and initialize it with the init command.

mkdir mysite
cd mysite
sculpin init

To generate the site, issue the generate command.

sculpin generate

License

Sculpin is licensed under the New BSD License - see the LICENSE file for details.

Community

Want to get involved? Here are a few ways:

  • Find us in the #sculpin IRC channel on irc.freenode.org.
  • Join the Sculpin Users mailing list.
  • Mention @getsculpin on Twitter.

Not Invented Here

There are other fine projects that are more mature than this one. If you are looking for a stable project with an established community, try something on the following admittedly incomplete list:

Something went wrong with that request. Please try again.