From 853984dfefac1810d74a82d426cf8aeb7849be75 Mon Sep 17 00:00:00 2001 From: Jeff Eberl Date: Thu, 6 Aug 2020 07:57:08 -0600 Subject: [PATCH] Updating the links in about, adding a CONTRIBUTING page, and linked to the wiki. --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ src/features/app/Footer.js | 15 ++++++++++++--- 2 files changed, 35 insertions(+), 3 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..27cd3557 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. + diff --git a/src/features/app/Footer.js b/src/features/app/Footer.js index ab9cf679..274a47cf 100644 --- a/src/features/app/Footer.js +++ b/src/features/app/Footer.js @@ -13,13 +13,22 @@ class Footer extends Component {

+
+

Instructions

+

+ Part of the fun of Sandify is playing it like you would a xylophone. +
+ 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. +
+ Check out the wiki for some features that you might miss the first time through. +

+
+

Sand Machine

Anything that uses gcode can be used with Sandify. But the machine this was designed for is the ZenXY from V1Engineering.com.

ZenXY on V1Engineering.com -
- ZenXY Thingiverse Page

ZenXY was inspired by the awesome Sisyphus kinetic art table by Sisyphus Industries, which is also now supported. @@ -33,7 +42,7 @@ class Footer extends Component {

Github

Sandify is hosted on Github here. Please post any problems, feature requests or comments in our issue tracker.

-

Sandify is a community project. We want and need developers. Help Sandify.

+

Sandify is a community project. We want and need collaborators. Help Sandify.