diff --git a/CHANGELOG.md b/CHANGELOG.md index 2261feba..bdf664dd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,6 @@ 0.0.1 (Mar 7th 2013) -------------------- -* First release on GitHub, basic working version +* WiP Upload of all files currently available +* Added upstream script collections +* Added SQL structure diff --git a/README.md b/README.md index 69b8f501..e60007cd 100644 --- a/README.md +++ b/README.md @@ -1,126 +1,37 @@ Description =========== -This is a simple PHP framework that I used in a few projects of mine. I -was getting annoyed how long it always took to get the basic setup of a -PHP website done (classes, pages, actions) so I wrote this framework to -help speed up my development process without using one of the big -frameworks out there. +mmcFE-ng is a web frontend for Pooled Mining. + +This is based on mmcFE, the original work by Greedi: +https://github.com/Greedi/mmcFE + +After working a few days trying to learn to run my own pool and the +systems behind it I figured I'd look a bit deeper in the code to +understand how it works. While doing so I also migrated the existing +code over to my own framework so maintenance would be easier in the +future. Requirements ============ -*No other software required* +* PHP MySQLnd Driver +* MySQL Server +* pushpoold +* litecoind -Overview -======== +Installation +============ -Here a quick overview on how the framework works. +No definite guide yet since this project is not in a working state as of +yet. -Classes -------- +Disclaimer +========== -* [[include/classes/]] - -For classes used in your projects, a debug class is already included. - -Pages ------ - -* [include/pages](include/pages)/`pagename`.inc.php - -For pages that are called by `index.php?page=`. *pagename.inc.php* -must exist and will be included by the index.php file when required. - -Actions -------- - -* [include/pages](include/pages)/`pagename`/`action`.inc.php - -For each page you can create a subdirectory that will be searched for callable -actions for a page: `index.php?page=&action=`. *action.inc.php* -must exist in the directory and will be included by the `index.php` file. - -Default Page ------------- - -Currently the framework always defaults to `home`. This still needs to be made -configurable at some point but technical difficulties made this impossible as -a short term solution. - -Default Action --------------- - -The default action for all pages is unset which means by default the page -include file is loaded. Once an action is defined the page include file -is skipped and the action loaded instead. - -Smarty Defaults ---------------- - -Smarty defaults are configured in the [include/smarty.inc.php](include/smarty.inc.php) file. Change -if need be but usually the defaults should work for you. - -Themes ------- - -As it is the framework has simple theming support. If you wish to add a new -theme create a subdirectory in templates and define that new theme in the -global.inc.php configuration file. You will also need to place any images -and the CSS in the site_assets directory (which is always public accessible). - -index.php ---------- - -The index file is taking care of including all your coded pages and actions. -Please prefix each class, function, action and page with a - - if (!defined('SECURITY')) - die('Hacking attempt'); - -This check ensures all files are called through the `index.php` and not directly. - -Setup -===== - -To use this framework simply upload everything to your webserver and change -the permissions on the - -`templates/compile` -`templates/cache` - -to `777` (read/write by everyone) so the Webserver can create the compiled -templates and cache files (if configured, disabled by default). - -Once installed just call the `index.php` and you should see the demo page. - -Debugger -======== - -This framework comes with a debugger. Examples on how to use them are given -inside the example pages. You can enable the debugger by setting the defined -DEBUG variable to your debugging verbosity level. Locate the file in: - -[include/config/global.inc.php](include/config/global.inc.php) - -You can also add any other defines and configuration variables you use -throughout your scripts in this file. It will be included by `index.php`. - -License and Author -================== - -Author:: Sebastian Grewe () - -Copyright:: 2013, Sebastian Grewe - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. +Since this is a heavy WIP there is no official support yet. The frontend +might work already but the entire backend (cronjobs) has not been +modified from the original yet and *will not work*. If you have a +working backend please get in touch with me - maybe with some +collaboration this project could be a great starting point for anyone +that likes to run their own pool.