Browse Source

docs: messing around with guides

[skip ci]
dev
Andy Meneely 9 years ago
parent
commit
c454bf43a4
  1. 14
      docs/guides/getting-started/part_2_iconography.rst
  2. 10
      docs/guides/getting-started/part_3_workflows.rst
  3. 18
      docs/guides/getting-started/part_4_leveraging_ruby.rst
  4. 3
      docs/guides/git.rst

14
docs/guides/getting-started/part_2_iconography.rst

@ -115,7 +115,7 @@ At this point, we've got a very scalable design for our future iterations. Let's
Why Ruby+YAML+Spreadsheets Works
--------------------------------
In software design, a "good" design is one where the problem is broken down into a set of easier duties that each make sense on their own, where the interaction between duties is easy, and where to place new responsbilities is obvious.
In software design, a "good" design is one where the problem is broken down into a set of easier duties that each make sense on their own, where the interaction between duties is easy, and where to place new responsibilities is obvious.
In Squib, we're using automation to assist the prototyping process. This means that we're going to have a bunch of decisions and responsibilities, such as:
@ -144,9 +144,21 @@ Icons for Some, But Not All, Cards
to be written
Method 1: Ruby Array#map
------------------------
Method 2: Use Layouts
---------------------
Methods 3: Use range
One Column per Icon
-------------------
.. note::
to be written
Don't Forget Unicode Icons
--------------------------

10
docs/guides/getting-started/part_3_workflows.rst

@ -1,4 +1,12 @@
The Squib Way pt 3: Workflows
===============================
To be written.
.. warning::
To be written.
* Build groups: color vs. black-and-white
* Splitting out decks into different files
* Setting up rake tasks
* Switch from built-in layouts to your own layout
* Launch what you need with Launchy

18
docs/guides/getting-started/part_4_leveraging_ruby.rst

@ -0,0 +1,18 @@
The Squib Way pt 4: Leveraging Ruby
===================================
.. warning::
To be written.
This part is about cataloging some powerful things you can do if you're willing to write some Ruby.
* Modifying XML at runtime (e.g. convert to black-and-white from color)
* Using Travis to build and then post to something like Dropbox
* Scaling the size of text based on its contents
* Advanced Array techniques: inject, transpose, map, join (use the pre-req example)
* Building newlines yourself (i.e. with your own placeholder like "%n" in Your Last Heist)
* Summarization card backs for Your Last Heist as an example
* "Lacks" string for Your Last Heist
* Rules doc written in Markdown

3
docs/guides/git.rst

@ -1,12 +1,13 @@
Squib + Git
===========
.. note::
.. warning::
To be written
Ideas:
* .gitignore
* Workflow
* Tracking binary data (show json method)
* Snippet about "what's changed"

Loading…
Cancel
Save