Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/philipsharp/afieldguidetoelephpants


https://github.com/philipsharp/afieldguidetoelephpants

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# Elephant Field Guide

Everything you need to know about [elephpants](http://php.net/elephpant.php)
in the wild. With acknowledgment to Roger Tory Peterson.

## Viewing Locally

_A Field Guide To Elephpants_ uses [Sculpin](https://sculpin.io/) to generate
its pages. Sculpin should be installed using [Composer](https://getcomposer.org/).

With Composer installed, run `composer install` from this directory. This will
install Sculpin and any necessary dependencies.

Once installed, use `vendor/bin/sculpin generate` to build the site. The
optional `--server` flag will start a local web server. Due to the single-page
nature of the _Field Guide_, the `--watch` flag may not work as expected.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for information on submitting changes,
including style and technical guidelines.

## Data

The following data feeds are available for elephpant-related projects. The data
feeds are licensed under the same terms as the website.

* - All elephpants and related species

## License

The content of A Field Guide to Elephpants is licensed under the [Creative
Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/),
and source code used to generate that content is licensed under the [MIT license](LICENSE).