Skip to content

Commit

Permalink
Merge pull request #173 from jeffeb3/feature/about-updates
Browse files Browse the repository at this point in the history
Updating the links in about, adding a CONTRIBUTING page, and linked t…
  • Loading branch information
bobnik authored Aug 6, 2020
2 parents 2b3a8f2 + 853984d commit b3dda0b
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 3 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## How to contribute

Sandify grows from community contributions. We'd love to collaborate with you. Here are some ways we
can improve together:

### Share Patterns

Even though we've spent a lot of time developing sandify, the patterns it can create suprise even
us. If you have used sandify to make a pattern, please share it, and share how it was done. We get
motivated seeing the impacts. Other users get inspired.

### Report Issues

Report bugs, feature requests, errors in the [issue
tracker](https://github.com/jeffeb3/sandify/issues). We can't test every scenario in every release
on every system. Many of the best ideas for features have come from issue requests.

### Contribute Code

Sandify has never been a one person effort. @jeffeb3 owns the project and guides the effort, but
most of the code has been written and rewritten by contributors. It is a pleasure to
work on, and we welcome collaboration.

15 changes: 12 additions & 3 deletions src/features/app/Footer.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,22 @@ class Footer extends Component {
</p>
</div>

<div>
<h2>Instructions</h2>
<p>
Part of the fun of Sandify is playing it like you would a xylophone.
<br/>
Try it out first. The goal is to make it easy to make your first pattern by just clicking and scrolling, finding something you like.
<br/>
Check out <a href="https://github.com/jeffeb3/sandify/wiki">the wiki</a> for some features that you might miss the first time through.
</p>
</div>

<div>
<h2>Sand Machine</h2>
<p>Anything that uses gcode can be used with Sandify. But the machine this was designed for is the ZenXY from V1Engineering.com.</p>
<p>
<a href="https://docs.v1engineering.com/zenxy/">ZenXY on V1Engineering.com</a>
<br />
<a href="https://www.thingiverse.com/thing:2477901">ZenXY Thingiverse Page</a>
</p>
<p>
ZenXY was inspired by the awesome Sisyphus kinetic art table by <a href="https://sisyphus-industries.com/">Sisyphus Industries</a>, which is also now supported.
Expand All @@ -33,7 +42,7 @@ class Footer extends Component {
<div>
<h2>Github</h2>
<p>Sandify is hosted on Github <a href="https://github.com/jeffeb3/sandify">here</a>. Please post any problems, feature requests or comments in our <a href="https://github.com/jeffeb3/sandify/issues">issue tracker</a>.</p>
<p>Sandify is a community project. We want and need developers. <a href="https://github.com/jeffeb3/sandify/wiki#developer-info">Help Sandify</a>.</p>
<p>Sandify is a community project. We want and need collaborators. <a href="https://github.com/jeffeb3/sandify/blob/master/CONTRIBUTING.md">Help Sandify</a>.</p>
</div>

<div>
Expand Down

0 comments on commit b3dda0b

Please sign in to comment.