FoOlSlideX/README.md

119 lines
3.3 KiB
Markdown
Raw Normal View History

2022-05-11 22:02:42 +02:00
2022-05-11 22:04:41 +02:00
![FoOlSlideX Logo](https://cdn.henai.eu/assets/images/foolslidex-logo.png)
2022-05-11 22:02:42 +02:00
# FoOlSlideX
The new, most powerful Comic- & Manga-Reader ever created by the human race. Reworked by an Otaku for Scanlation-Groups.
Before contributing, make sure to read [Contributing](#contributing)! Make sure you start with [TYP-xxx] or else it won't be merged!
2022-05-11 22:02:42 +02:00
## Index
- [Features](#features)
- [Contributing](#contributing)
2022-06-12 22:27:08 +02:00
- [Video-Guides](#video-guides)
- [Installation using the Installer](#installation-using-the-installer)
2022-05-11 22:02:42 +02:00
- [Documentation](#documentation)
2022-05-11 22:05:27 +02:00
- [Config Variables](#config-variables)
2022-05-11 22:02:42 +02:00
- [Supprt](#support)
- [Donate](#donate)
- [Demo](#demo)
2022-05-11 22:05:27 +02:00
- [Used By](#used-by)
2022-05-11 22:02:42 +02:00
- [Authors](#authors)
2022-05-11 22:02:42 +02:00
## Features
- Create invites
- Register using invite & login to Account
- Add Titles/Edit them
- Add Chapters/Edit them
- Bookmark Mangas & Chapters via Cookies
- View Bookmarks & keep track of them
- Create Groups, view groups and their chapters
- Create static pages & manage them
2022-05-11 22:02:42 +02:00
## Contributing
Contributions are ALWAYS welcome! Even if it's just improving a language-file. Really!
Make sure you follow these rules!
- Commit Message should follow this title system: [TYP-xxx] where xxx is the typ type. ([See more in deathnotes.txt at the footer where types are declared](https://github.com/saintly2k/FoOlSlideX/blob/master/deathnotes.txt))
- Code should somewhat be clean and readable
- Notes in the code should be in ENGLISH and no other language (except language files)
2022-06-12 22:27:08 +02:00
## Video-Guides
As someone requested, I started a video-guide on YouTube on how to install, update and do some more stuff on FoOlSlideX.
[View the full PlayList](https://www.youtube.com/playlist?list=PLDQvUzXjsrhP8EsCrxJ6yoqcOKTESXixX)
## Installation using the Installer
2022-05-11 22:02:42 +02:00
- Download the latest stable release
- Create a MySQL Database
- Open your webroot in your browser
- Fill out all data and click on submit
- Create an account using the invite code `FoOlSlideX`
2022-05-11 22:02:42 +02:00
- Done
## Documentation
[View full Documentation in the GitHub Wiki](https://github.com/saintly2k/FoOlSlideX/wiki)
2022-05-11 22:02:42 +02:00
## Config Variables
`$slave["host"]` is the MySQL host
`$slave["user"]` is the MySQL user
`$slave["pass"]` is the password for the user
`$slave["table"]` is the table where you imported the SQL file
## Support
For support, join our Discord: https://discord.gg/uahG2fKVvg
Or eMail me at saintly@h33t.moe
## Donate
I spend a lot of time working on this. Really.
2022-06-12 22:25:19 +02:00
Please consider donating some money via PayPal: [yuki.akihabara@yandex.com](https://paypal.me/WOLFRAMEdev)
Or donate via Ko-fi: [ko-fi.com/saintly](https://ko-fi.com/saintly) (I need to pay server-bills)
2022-05-11 22:02:42 +02:00
## Demo
View (a slightly modified version of) FoOlsldiex in action: https://stukas.henai.eu/reader/
## Used By
This project is used by the following groups:
- [Lubuntu Bionic Beaver Scans](https://stukas.henai.eu)
- [weltenWanderer Scans](https://wws.henai.eu)
2022-06-07 22:31:45 +02:00
- [ELEVEN SCANLATOR](http://eleven-scanlator.epizy.com)
- [PuchiRoll](https://puchiroll.com)
2022-05-11 22:02:42 +02:00
## Authors
FoOlSlideX Development:
- [@saintly2k](https://www.github.com/saintly2k)
- [@kaligula-eu](https://www.github.com/kaligula-eu)
2022-05-11 22:02:42 +02:00
2022-06-07 22:31:45 +02:00
Translation:
2022-06-12 22:25:19 +02:00
- EN: [Saintly2k](https://github.com/saintly2k)
- DE: [Saintly2k](https://github.com/saintly2k)
2022-06-07 22:31:45 +02:00
- PT: Luckkyz
2022-06-12 22:25:19 +02:00
- RU: [RenOK](https://github.com/totavok8)
2022-05-11 22:02:42 +02:00
2022-06-07 22:31:45 +02:00
FoOlSlide/FoOlSlide2 Original Idea/Development:
2022-05-11 22:04:41 +02:00
- [@FoolCode](https://github.com/FoolCode)