diff --git a/README.md b/README.md new file mode 100644 index 0000000..787b459 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# TICKETEE + +An exploration/experiment in open source for #CodeNewbies + +## Get Started: + +### Fork the app! +![Click fork](doc/images/fork-project.png) +### Download/clone the app! +![Click clone](doc/images/clone-project.png) +* Copy the URL in the clone with HTTPS window. +* Open a terminal of your choice +* Change to a directory where you keep your source code + * For eg. `cd ~/source-code` +* Run the command `git clone [paste the url you copied here]` + * in my case I used `git clone https://github.com/shadowcliff/ticketee.git` + +### Open in your favorite editor... +I use VSCode but feel free to use Atom/Vim/RubyMine or whatever. Import the project using your IDE (Or in VSCode merely open the folder you cloned it to). + +### Change some code locally... +I'm using this Documentation as an example of my first pull request. + +### Commit and push your changes +Either use your IDE to commit and push the changes or run: +* `git add -A` +* ...to stage all changed files for commiting +* `git commit -m 'I changed some stuff to make stuff better` +* ...to perform the actual commit. (Use your own commit message.) +* `git push` +* ...to push your commit to your account on github! + +### Create a Pull Request +Open Github in your browser and click the create Pull Request button! + +### Wait for smoke (Feedback) +Operators are standing by! Someone working on this project should either approve your PR or give you feedback momentarily! \ No newline at end of file diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index dd4e97e..0000000 --- a/README.rdoc +++ /dev/null @@ -1,28 +0,0 @@ -== README - -This README would normally document whatever steps are necessary to get the -application up and running. - -Things you may want to cover: - -* Ruby version - -* System dependencies - -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... - - -Please feel free to use a different markup language if you do not plan to run -rake doc:app. diff --git a/doc/images/clone-project.png b/doc/images/clone-project.png new file mode 100644 index 0000000..e8cab74 Binary files /dev/null and b/doc/images/clone-project.png differ diff --git a/doc/images/fork-project.png b/doc/images/fork-project.png new file mode 100644 index 0000000..d4ad8d5 Binary files /dev/null and b/doc/images/fork-project.png differ