tgpholly/Revolution
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix formating and add extra projects section.

Browse source
This commit is contained in:
tgpethan 2020-01-03 04:57:06 +00:00
parent e660904aff
commit 402c6399fb
1 changed files with 13 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -6,23 +6,24 @@
</p>
<h2 align="left">What is Revolution for?</h2>
<p align="left">Basically anything. As long as you want to try it, it’s probably possible.
</p>
<p align="left">Basically anything. As long as you want to try it, it’s probably possible.</p>
<h2 align="left">How does Revolution work?</h2>
<p align="left">Revolution uses a set of modules to handle various functions, there are two modules included with the repo and builds, these being consoleHelper and example_request_handler. consoleHelper is a required module and as such the framework will not start without it, however example_request_handler can be removed without consequence and is there purely to help with module development.</p>
<h2 align="left">How do modules work?</h2>
<p align="left">Modules are loaded in at runtime and are completely separate from each other. Each module has a prefix, for example the request handlers have the prefix “handle_console”. These prefixes determine the function of the modules and help the server to function.</p>
<h2 align="left">How to use Revolution.</h2>
<h3 align="left">From source</h3>
<p align="left">git clone https://github.com/tgpethan/Revolution.git</p>
<p align="left">cd Revolution</p>
<p align="left">npm i</p>
<p align="left">node . </p>
<p align="left">git clone https://github.com/tgpethan/Revolution.git<br>
cd Revolution<br>
npm i<br>
node . </p>
<h3 align="left">From build</h3>
<p align="left">Download latest build (https://github.com/tgpethan/Revolution/releases/latest)</p>
<p align="left">Unzip the zip</p>
<p align="left">Run revolution executable</p>
<a href="https://github.com/tgpethan/Revolution/releases/latest">Download latest build</a>
<p align="left">Unzip the zip<br>
Run the Revolution executable</p>
<h2 align="left">How to install modules.</h2>
<p align="left">With modules you simply have to place the module inside the modules folder and start the server.
<p align="left">With modules you simply have to place the module inside the modules folder and start the server.<br>
The modules will automatically set themselves up and the server will start as normal.
</p>
<h2 align="left">Projects Revolution is used in</h2>
<a href="https://github.com/tgpethan/EUS/">EUS</p>