Skip to content

Commit cb6965c

Browse files
committed
Updated Readme
1 parent d7c1631 commit cb6965c

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
11
# ReactCasts
2-
Source code for ReactCasts
2+
3+
This repository has code and outlines for [ReactCasts](https://www.youtube.com/channel/UCZkjWyyLvzWeoVWEpRemrDQ). All content (code samples, outlines, etc...) is organized into folders, starting with [`episode1`](https://github.com/cassiozen/ReactCasts/tree/master/episode1) and going from there.
4+
5+
# Request A Screencast
6+
7+
I have some ideas for topics to cover, but if you want to see some topics covered in a future screencast, I'd like to hear from you.
8+
9+
Please [submit an issue](https://github.com/cassiozen/ReactCasts/issues) with the `request a screencast` label and make sure to include a good description on what you want to see!
10+
11+
You can also participate by adding your reactions and contributing to the discussion on suggested topics: https://github.com/cassiozen/ReactCasts/issues/labels/request%20a%20screencast.
12+
13+
# Issues With Code, Documentation, etc...
14+
15+
If you see any problems with code, documentation, or anything else in this repository, please [submit an issue](https://github.com/cassiozen/ReactCasts/issues) with the `bug` label and I'll fix it as soon as I can. Pull requests are also welcome.
16+
17+
# Build, Test and Run Instructions
18+
19+
All the folders that start with `episode` (such as [`episode1`](https://github.com/cassiozen/ReactCasts/tree/master/episode1) contain the outline and code samples for that episode, and all code samples can be built and run.
20+
21+
Unless otherwise specified in the `README.md` in the episode folder, the commands for building, testing and running simply use the `npm` tool.
22+
23+
- install packages: `npm install`
24+
- run: `npm start`
25+
26+
# Acknowledgements
27+
28+
The ReactCasts series is heavily inspired by the original [Rails Casts](http://railscasts.com) series by Ryan Bates. He is the pioneer that given shape to the format.
29+
30+
The format of this repository, including the usage of issues for requesting screencast was created by Aaron Schlesinger for the fantastic [Go in 5 minutes](https://github.com/arschles/go-in-5-minutes) screencast series.
31+
32+
The music used on the episodes is a royalty-free piece http://www.bensound.com

0 commit comments

Comments
 (0)