Skip to content

Commit

Permalink
Merge pull request #1 from noelrappin/patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
mghaught authored Mar 20, 2021
2 parents e60ccaf + 5fa06fb commit a3c4ccf
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# Workshop Template

This readme lays out out a consistent structure for RailsConf workshops to follow.  We recommend you use this readme to seed your workshop's repo.  Fill in the sections below as appropriate for your workshop.
This readme file lays out out a consistent structure for RailsConf 2021 workshops to follow.  We recommend you use this readme to as the basis of your workshop's repo.  Fill in the sections below as appropriate for your workshop.

# <Workshop Name>

Include the description for your workshop.  Typically this would be the same description that you have for the program page.  We do recommend you make it clear this is part of the conference and link back to the conference program page.  A good description should include what will the workshop cover, what will the attendees get out of the workshop, and generally the expected skill level targeted.
Include the description for your workshop.  Typically this would be the same description that you used for the program page.  We do recommend you make it clear this is part of the conference and link back to the conference program page at <http://rubyconf.org>.  A good description should include what the workshop covers, what the attendees will get out of the workshop, and the expected skill level of the attendees.

For RailsConf 2021, you'll want to link to the Discord channels that will be used.
For RailsConf 2021, you'll want to link to the Discord channels that will be used, URLs to come.

## Prerequisites

This section should list out whatever is required by attendees to successfully participate in the workshop.  This is important in case they realize they can't fulfill those and thus should reconsider attending.
This section should list out anything that is required by attendees before the workshop starts in order to successfully participate in the workshop. This is important in case they realize they can't fulfill the prerequisites and thus should reconsider attending.


## Getting Ready

This section includes the steps an attendee should take to get fully prepared for the start of the workshop.  If the workshop will be executing code from a starting app, I'd expect any installation steps to get up and running.  If there is any homework before the start, list that out.
This section includes the steps an attendee should take to get fully prepared for the start of the workshop.  If the workshop will be executing code from a starting app, please include all the installation steps to get up and running, including the versions of any languages or tools needed, such as Ruby or Node/NPM.  If there is any homework before the start, list that out too.

Thanks! Making sure the attendees are prepared goes a long way to having a successfull workshop.

0 comments on commit a3c4ccf

Please sign in to comment.