From 935040b342ffeb8f29ff66ada7842068768e3449 Mon Sep 17 00:00:00 2001 From: Andy Meneely Date: Sat, 26 Nov 2016 09:50:19 -0500 Subject: [PATCH] docs: projects using squib --- CHANGELOG.md | 3 ++- docs/guides/projects.rst | 35 +++++++++++++++++++++++++++++++++++ docs/learning.rst | 3 ++- 3 files changed, 39 insertions(+), 2 deletions(-) create mode 100644 docs/guides/projects.rst diff --git a/CHANGELOG.md b/CHANGELOG.md index c082c86..626275c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,7 +15,8 @@ Bugs: Docs: * Wrote out documentation for [Squib and GameIcons](http://squib.readthedocs.io/en/latest/guides/game_icons.html) * Wrote out documentation for Hello World! Dissected -* Began un-submoduling our samples and simply embedding them into the code (e.g. [Squib Thinks in Arrays](http://squib.readthedocs.io/en/latest/arrays.html)) +* Un-submoduled our samples and simply embedded them into the docs (e.g. [Squib Thinks in Arrays](http://squib.readthedocs.io/en/latest/arrays.html)). Lots of cleanup there +* Wrote up [Squib in Action](http://squib.readthedocs.io/en/latest/guides/projects.html), which documents other Squib projects. Ask for yours to be put there!! Chores: * Bumped dependency roo to 2.5.1. Nothing that affects Squib users (probably). diff --git a/docs/guides/projects.rst b/docs/guides/projects.rst new file mode 100644 index 0000000..6e3d3ea --- /dev/null +++ b/docs/guides/projects.rst @@ -0,0 +1,35 @@ +Squib in Action +=============== + +Squib is in use by a lot of people! You can learn a lot from looking at how a whole project is put together. + +A good way to peruse Squib code is to search for Ruby files on GitHub that have the phrase ``require 'squib'`` in them. And these are the just the people who have decided to release their code open source! + +My Projects +----------- + +Here are some of my own board and card games that use Squib. They are all under "active" development, which means that sometimes I leave them alone for long periods of time ;) + + * `Your Last Heist `_ is a big-box cooperative game. Lots of really cool Squib things in here, including lots of Rake features, color+bw, and showing how skills can "level up" on their backs by diff'ing the stats in Squib. You can see what the components look like at `the game website `_. Also: the best game I've ever made. + * `Victory Point Salad `_. A card-only game with lots and lots and lots of cards. Pretty straightforward as far as Squib usage goes, but it's a good peek into how I like to use Squib. Also: the funniest game I've made. + * `Junk Land `_ A game I made prior to making starting Squib, but then ported over to Squib while developing Squib. Uses some strange features of SVG, but also a good intro. Also: the scrappiest game I've made. + +.. note:: + + Want to donate back to Squib? Volunteer to playtest these games :) + +Other Projects using Squib +-------------------------- + +Poking around GitHub, here are a few sightings of Squib: + + * `Ecovalia `_ - a game rapidly prototyped in a hackathon. Squib is featured in their video! + * `Werewolf `_ implemented and even uses GitHub releases! + * `Cult Following `_ is a neat-looking project + * ScrapyardArmory's `Dysplacement `_ was used with Squib, and **won** the `Worker Placement contest `_ over at TheGameCrafter. + * `Mad World `_ uses CircleCI to build, even with some custom fonts. + +Want yours here? +---------------- + +Create an issue on Github and ask for a link her and we'll add it here! diff --git a/docs/learning.rst b/docs/learning.rst index 77680bb..1df45b0 100644 --- a/docs/learning.rst +++ b/docs/learning.rst @@ -6,6 +6,7 @@ Learning Squib guides/hello_world guides/getting-started/index - guides/git + guides/projects guides/game_icons + guides/git guides/guard