edited community instructions & adding beginnings of custom widget doc

Esse commit está contido em:
Conor Russomanno
2017-09-04 10:48:08 -07:00
commit a3e97b64c9
2 arquivos alterados com 23 adições e 15 exclusões
-15
Ver Arquivo
@@ -8,7 +8,6 @@ The **OpenBCI Community** interface is our latest project. It consists of:
* [The People](http://openbci.com/community/people/) - you! The people making posts and creating challenges
* [The Feed](http://openbci.com/community/) - where new community posts end up
* [Challenges](http://openbci.com/community/challenges/) - unfinished hackathon projects, suggested projects, or requests for help
* [Join](http://openbci.com/community/wp-login.php?action=register) - the way to register (send this to your friends)!
After you [register](http://openbci.com/community/wp-login.php?action=register) and are verified (we must approve your application), your account will be switched from **subscriber** to **contributor**. After this, you'll be able to create posts and challenges! Posts appear in the [Community Feed](http://openbci.com/community/), and challenges appear on the Challenges Page. More on this below.
@@ -34,20 +33,6 @@ Our community page is based on the Wordpress platform. If youve used Wordpres
**If you have your own blog/website** where youll be posting content related to OpenBCI, create an “OpenBCI” tag that you can assign to your posts, and then send us your blogs URL. We can then add your RSS/tag/OpenBCI feed to our community page. Your posts will then automatically appear in our Community Feed and redirect back to your blog!
### Proposing/Joining Challenges
A “challenge” is similar to a post, but different in the sense that you are requesting help from the community. You can consider it an unfinished project. Hackathons are a great place to start a challenge!
To create a challenge:
1. First, you must have a verified OpenBCI Community account and a [Github](https://github.com/) account
* Create a Github repo that will host the code, assets, and other content for your challenge
* Go to the [Challenges Page](http://openbci.com/community/challenges/) and click the [“Start A New Challenge”](http://openbci.com/community/wp-admin/post-new.php?post_type=challenge) button
* From the Wordpress admin panel, select: Challenges > Add New
* Add a challenge title, a featured image, your Github repos URL, and a Challenge Description. Then click the “Publish” button on the right-hand side (this is very similar to making a Wordpress post).
You can upvote other peoples challenges, or join challenges by forking and contributing to the github repo of the challenge. All Github activity related to a challenge is automatically tracked on the challenge page!
### On The Horizon
The OpenBCI Community interface will be forever under development. We really want your feedback! If you have suggestions, please let us know (conor [at] openbci [dot] com).
+23
Ver Arquivo
@@ -0,0 +1,23 @@
# Custom Widgets
This tutorial shows you how to create your own custom widgets for the [OpenBCI GUI](https://github.com/OpenBCI/OpenBCI_GUI). In just a few easy steps you can have your own mini applications added to the dropdown menus of the OpenBCI GUI for running specialized applications in real-time. These widgets can tap directly into the main data structure of the OpenBCI GUI, so you can experiment with brain waves and other bio data right in the GUI.
## Helpful Background Skills
* Knowledge of [Processing](https://processing.org/) or Java-based programming
* Experience with [running the OpenBCI GUI from the Processing IDE](http://docs.openbci.com/OpenBCI%20Software/01-OpenBCI_GUI#the-openbci-gui-running-the-openbci-gui-from-the-processing-ide)
### Step 1 - copy the w_template.pde file & rename
### Step 2 - add your new widget to the widgetManager.pde file
### Step 3 - make sure your widget appears in the widget dropdown
### Step 4 - design your custom widget
### Step 5 - share your custom widget with the world!