Add a README.md

README.md

@@ -0,0 +1,13 @@
+rva_cars/
+===
+
+Re-Volt America's Cars Pack.
+
+## Usage
+For developers, the packaging pipeline was built using Rake. The following tasks take care of compressing and versioning
+the files included in the cars pack:
+  - `:clean`: Removes all unnecessary files from cars/, such as paintkits, extra folders, etc. Use it before pushing to this repo!
+  - `:package`: Packages the whole cars/ directory into a zip file.
+  - `:version`: Generates a packages.json file, which is later used for distributing the pack via the [RVGL Launcher](https://re-volt.gitlab.io/rvgl-launcher/#download)
+
+Using `rake` on its own will execute all in its intended order: `:clean, :package, :version`.

Rakefile

@@ -53,7 +53,7 @@ task :package do
   zipfile_name = "#{RVACars::NAME}.zip"
   puts "Packaging into #{zipfile_name} ..."
 
-  exclude = %w[. .. Gemfile Gemfile.lock Rakefile .git .gitignore .idea data.rb]
+  exclude = %w[. .. Gemfile Gemfile.lock Rakefile .git .gitignore .idea data.rb README.md]
   zf = ZipFileGenerator.new('.', zipfile_name, exclude)
   zf.write