README.md in generic_app-0.0.1 vs README.md in generic_app-0.1.0

- old
+ new

@@ -1,29 +1,34 @@ # GenericApp +## Prerequisites + +You must have not only Ruby on Rails installed but PostgreSQL installed as well. Everything you need to use GenericApp is pre-installed in my Debian Stable Vagrant Box for Ruby On Rails ( https://github.com/jhsu802701/vagrant_debian_wheezy_rvm ). + ## Installation Install it yourself with the command: $ gem install generic_app ## Usage -Once you have installed this Ruby gem, just go to the directory where you -keep your Rails projects and enter the command "generic_app". You will be -asked to provide a name for the subdirectory you wish to have created and -used for your new Rails app. +### Creating A Rails App +Go to the directory where you keep your Rails projects and enter the command "generic_app". You will be asked to select the name of the directory you wish to use for your Rails project, and you will be asked whether you wish to use the SQLite or PostgreSQL database in your development environment. If you choose PostgreSQL, you will be asked for database parameters. +<br><br> +After you have provided all of the necessary parameters, your generic Rails project will not only be created for you but automatically tested as well. All this takes a few minutes instead of several long and grueling hours. + ## What's the point? Welcome to Ruby On HIGH SPEED Rails! The GenericApp gem saves you time by automatically providing the basic elements and features that nearly all Rails apps require. Instead of spending hours reinventing the wheel, you can spend more of your time on the more advanced features and capabilities that are unique to your specific Rails app. Modifying a generic app takes far less time than creating an app completely from scratch. <br><br> Creating a basic generic web site with user capability and testing is a long and slow process that spans chapters -3 through 10 at railstutorial.org. The GenericApp Ruby gem allows you to create such a site in seconds instead of +3 through 10 in railstutorial.org. The GenericApp Ruby gem allows you to create such a site in seconds instead of hours. This is valuable for any project and essential for events like Startup Weekend and 24-hour website challenges. <br><br> The GenericApp gem copies the railstutorial.org Sample App for use as a template for starting a new project. (Note that the microposts and followers features are not included, because they are specific to the Sample App.) @@ -39,23 +44,19 @@ 2. Tests 3. Automated tests through Guard 4. Twitter bootstrap 5. Databases: SQLite3 for development and PostgreSQL for production 6. Ready for Heroku deployment -7. User functionality: includes hashed passwords, administrative users, -account activations, and password resets +7. User functionality: includes hashed passwords, administrative users, account activations, and password resets This generic Rails app provides the above features PLUS these additional features: -1. Bash scripts in the root directory that allow you to perform routine -tasks in only one step. (These scripts are likely to be useful in Rails -apps that were not created with this generic_app Ruby gem.) -2. Recommendations that the user make use of password management software -to generate and store secure passwords -3. Outlines of the MVC, test suite, and database seeding process in the -notes folder +1. Bash scripts in the root directory that allow you to perform routine tasks in only one step. (These scripts are likely to be useful in Rails apps that were not created with this generic_app Ruby gem.) +2. Recommendations that the user make use of password management software to generate and store secure passwords +3. Outlines of the MVC, test suite, and database seeding process in the notes folder 4. Guard automatically runs tests upon startup. +5. If you choose PostgreSQL (instead of SQLite) as your development environment database, the parameters are automatically set on your machine AND in the app for you, and the username and password are EXCLUDED from the source code saved with Git. ## Contributing 1. Fork it ( https://github.com/jhsu802701/generic_app/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`)