chore(readme): add readme w/ known caveats
This commit is contained in:
parent
8a39ba96e7
commit
43dab51e3b
13
README.md
13
README.md
@ -1,4 +1,3 @@
|
||||
|
||||
# RBRecruiter v1.0.2-stable - Integrated Human Resources Management System
|
||||
|
||||
**Are the big name HR apps too bloated and overkill for your online community? Check RBRecruiter out to see if its right for you!**
|
||||
@ -42,6 +41,18 @@ Tech stack:
|
||||
- [jQuery](https://jquery.com/)
|
||||
- [Icons by FontAwesome](https://fontawesome.com/)
|
||||
|
||||
# Known caveats
|
||||
|
||||
**Incompatible PHP extensions**
|
||||
|
||||
The following PHP extensions are known to cause problems throughout the app (resulting in numerous errors):
|
||||
|
||||
- [PHP PSR - PSR Interfaces](https://pecl.php.net/package/psr)
|
||||
|
||||
This is because the extension conflicts with a package Laravel uses, [Monolog](https://github.com/Seldaek/monolog), which is required for logging across the whole application. Oftentimes, removing this extension with your system's package manager or disabling it in ``php.ini`` does the trick and gets things to work again.
|
||||
|
||||
*This issue should not affect versions below 1.0.0.*
|
||||
|
||||
# Stability
|
||||
|
||||
At the moment, each new feature goes into its separate branch so that ``main`` remains stable. When the features being worked on are ready and tested, they are merged onto ``main``, and a new release can be started. The main branch is write-protected.
|
||||
|
Loading…
x
Reference in New Issue
Block a user