From 17bbce7368e7e16c5694105509969b7928e62552 Mon Sep 17 00:00:00 2001
From: Maruno17 <serialcolour@hotmail.com>
Date: Sat, 5 Sep 2020 17:12:20 +0100
Subject: [PATCH] Updated readme

---
 Data/Scripts.rxdata | Bin 359 -> 548 bytes
 README.md           |  37 ++++++++++++++++++++++++++++++++++++-
 2 files changed, 36 insertions(+), 1 deletion(-)

diff --git a/Data/Scripts.rxdata b/Data/Scripts.rxdata
index b6ed00a3ff9302c6c1652b05b14ee990af0dbf5d..e84ec884fceb62fedc89a7c4cc46b5ed559c523a 100644
GIT binary patch
delta 539
zcmV+$0_6SY0;B|x6n_o^c$|Gx!EW0y47~@)KQL|pTWFv(#|_AOShr!P4NY!IV8}M@
zXmun*l9zRH{=JeN+i~0NB8a5;NIpK@z<SR$BoZ|UY2YZ;6Yvzw9wB1~1RF#VtLMUC
zG8vD?qXcbKu^1y3KZOblsmyo;;LO?&OPEe*XVN&A0tYWBvVVAgf+{kV^V^7_x{M~l
z{1j}HTXLQgIC-0!({yp(+4J$+Y89?NKYstYUTvleYGlZFo5k+zon3x?C^V%KuJQr3
zW*NdQcw4a*p1t&ye@QL^>-Wfbgd%ANQjBX1`>{|dsT{1OqKBlK|3&z;gb#OjP2*pA
zj#L&X0>4Y9xqr<38Td!vP61U~K}wH`8w{os(liTALGagYlH=J(2@%gI{3uOP8sGwk
zpe_}2jaLx0%gu2$OfFdx>R9o@=rC3C5T-IuPz41ud*U)u+qSk4OW5pcyN>J5e&C9x
zQn@uXNmd|klBTf0KgJQ0!g2{d^`WZTJN26<K}}4;6@SJ?s^|L}#cgEn){znd_ia&H
zlzJbe1U_E+Y8~BZtzTQEO?uOHH|Q&ti4$MHlVQ;rc*^TnVy8>mZA6%H(OhlK-z*Ot
z7P;_@IxZ1bHKAWxVf0J93Q&Q^px4U)piR1#lhb@}&))niGN|;PK0At9rY@xRTwNS*
d*!r(Zt`t`FT4Ddp^B$OC^M(!Wkr!qyPWxZq|5yM3

delta 348
zcmV-i0i*t;1m^;f6n{|xc$|Gw%TB{E5WH9FKWqY0V^O(xq^g&~55Ntf$hFsv)zpsG
zE~O&;JI<>iAh=le&hE_YBscI}7!S&!2kQcy9UZ`E2nE7k91$XjR??*ksFL|ip@z~4
zm3v913O?85j=6TFLdq%;3O1hsXj4W$fHl0lw(l1A*Z0;C*ME*s$f6sH2B6k;g8^84
z4~+*6>oqL+0_u9W^F`N^Jw^qt4518;E}NDG?jT*I@zjjLW)S7o$rqVsaNqkH3Jnul
zb@j`=qmYcx#@)o1bPD4Nt+cDq{t#V4N-2YnW&kvg+bQ_$CU>|uw!22nH&JE{7wam7
zUY-!1+CU$O990dSB#fT`+~PUAP52SL7yBu}Ff_v4pLWT&_9X-o5_du#a>6QZ%O*<s
u2;*p@k7!7$4|U9{FZ@dD-@oMBr@E52$9(qZT)GuOthzLO%Dw<YThYG?K&cl1

diff --git a/README.md b/README.md
index b41cedee1..15bc7c871 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,36 @@
-# pokemon-essentials
\ No newline at end of file
+# Pokémon Essentials
+
+Based on Essentials v18.
+
+You can build your fangame on top of a fork of this repository. Doing so will let you update your fangame with improvements made to this repo as soon as they are made.
+
+## Usage
+
+1. Fork this repo.
+2. Get a copy of Essentials v18 (a download link cannot be provided here).
+3. Clone your forked repo into the Essentials v18 folder, replacing the existing files with the ones from the repo.
+
+From here, you can edit this project to turn it into your fangame/develop mods. When this repo is updated, you can make a pull request to update your fork and get the updated into your fangame/modding environment.
+
+## Scripts
+
+The scripts no longer live in the Scripts.rxdata file. They have been extracted into separate files and placed in the Data/Scripts/ folder (and subfolders within).
+
+The scripts are loaded into the game alphabetically, starting from the top folder (Data/Scripts/) and going depth-first. All scripts in a given folder are loaded, and then each subfolder is checked in turn (again in alphabetical order) for files/folders to load/check.
+
+### Reintegrating scripts for an encrypted release
+
+This repo contains script_dumper.rb (in the main folder) which can be run to integrate the individual script files back into Scripts.rxdata, and to extract them. At the bottom of script_dumper.rb are two lines, one for each action.
+
+This will not be described in detail, as the intention is to replace it with something more user-friendly.
+
+## Files not in the repo
+
+The .gitignore file lists the files that will not be included in this repo. These are:
+
+* The Audio/ and Graphics/ folders and everything in them.
+* Everything in the Data/ folder, except for:
+  * The Data/Scripts/ folder and everything in there.
+  * Scripts.rxdata (a special version that just loads the individual script files).
+* A few files in the main project folder (the three Game.xxx files, and the RGSS dll file).
+* Temporary files.
\ No newline at end of file