From f8bb541c81bacd9f065cb69ff454d6a8ee7f4d90 Mon Sep 17 00:00:00 2001 From: Cooldude2606 Date: Fri, 14 Jul 2017 22:16:43 +0100 Subject: [PATCH] Edit To Readme --- README.md | 37 ++++++++++++++++--------------------- gulpfile.js | 16 ---------------- package.json | 24 ------------------------ 3 files changed, 16 insertions(+), 61 deletions(-) delete mode 100644 gulpfile.js delete mode 100644 package.json diff --git a/README.md b/README.md index 14530b97..bffb273f 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,18 @@ -#### How to install? +####Using The Core Files +1. Copy the core folder and the StdLib File +2. Require StdLib event.lua before the core file-header +3. Use require to run the file-header inside the core file +4. Make any changes to the rank table you wish to use +5. Add you own code to the stand alone folder using the function defined in core -1. Open terminal / cmd in the folder. -2. Run: -``` -npm install -``` +####Using The Addons +1. Copy the addons folder +2. Remove any you do not wish to have +3. Remove the require inside the addons file-header -#### How to run once? - -1. Open terminal / cmd in the folder. -2. Run: -``` -gulp -``` - -#### How to watch file? - -1. Open terminal / cmd in the folder. -2. Run: -``` -gulp watch -``` +####Making Your Own Addons +* Make sure to require it after the core files +* Add and return the credits vaible with your info inside +* Make sure the core is upto date with out latest version +* It is recomened that your do not edit the core file +* The core files use comments to help explain the many functions diff --git a/gulpfile.js b/gulpfile.js deleted file mode 100644 index 9c5f1531..00000000 --- a/gulpfile.js +++ /dev/null @@ -1,16 +0,0 @@ -var gulp = require('gulp'); -var rename = require('gulp-rename'); -var luaminify = require('gulp-luaminify'); - -gulp.task('minify', function () { - return gulp.src(['source.lua']) - .pipe(luaminify()) - .pipe(rename('control.lua')) - .pipe(gulp.dest('.')); -}); - -gulp.task('watch', function() { - gulp.watch('source.lua', ['minify']); -}); - -gulp.task('default', ['minify']); \ No newline at end of file diff --git a/package.json b/package.json deleted file mode 100644 index e2005624..00000000 --- a/package.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "name": "explosivegaming-scenario", - "version": "1.0.0", - "description": "", - "main": "index.js", - "scripts": { - "start": "node index.js" - }, - "repository": { - "type": "git", - "url": "git+https://github.com/badgamernl/explosivegaming-main.git" - }, - "author": "badgamernl", - "license": "ISC", - "bugs": { - "url": "https://github.com/badgamernl/explosivegaming-main/issues" - }, - "homepage": "https://github.com/badgamernl/explosivegaming-main#readme", - "dependencies": { - "gulp": "^3.9.1", - "gulp-luaminify": "0.0.1", - "gulp-rename": "^1.2.2" - } -}