-
Notifications
You must be signed in to change notification settings - Fork 79
Update README.md #195
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: release/16.0
Are you sure you want to change the base?
Update README.md #195
Conversation
Make current for FreePBX 16 stack
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the README.md to reflect the current FreePBX 16 stack while indicating a need for similar updates for version 17.
- Updated links and formatting for various dependencies
- Restructured sections including Tech Stack, Visuals, and Installation
- Expanded dependency details with version information and license links
Comments suppressed due to low confidence (1)
README.md:103
- Consider verifying and updating the placeholder URL for jQuery UI Bootstrap to the correct project URL if available.
* [**jQuery UI Bootstrap**](https://github.com/your-repo-link-here/jquery-ui-bootstrap/blob/master/LICENSE.txt) (Note: Original project link might be difficult to find, using a common license.)
chrsmj
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This appears to be an AI generated PR with multiple inaccuracies, specifically regarding incorrect version number inferences for included libraries.
| ========= | ||
|
|
||
| FreePBX is an Open Source GUI (graphical user interface) that controls and manages [Asterisk (PBX)]. | ||
| Please see the included license file in the module for license information |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add a period at the end of this sentence, but please don't remove the license info.
| * [CssMin] - A (simple) css minifier with benefits. By Joe Scylla, Copyright (c) 2008 - 2010. License MIT | ||
| * [Codeigniter helpers/librarires] - Copyright (c) 2008 - 2011, EllisLab, Inc., All rights reserved. License GPL | ||
|
|
||
| This project leverages a variety of robust PHP libraries for its backend functionality. Below is a list of the primary dependencies, along with their licenses and project links for further information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new description of this section is inaccurate because Asterisk is not a PHP library.
| This project leverages a variety of robust PHP libraries for its backend functionality. Below is a list of the primary dependencies, along with their licenses and project links for further information. | ||
|
|
||
| * [**Alchemy/Zippy**](https://github.com/alchemy-fr/zippy) (~0.4.9) - [MIT License](https://github.com/alchemy-fr/zippy/blob/master/LICENSE) | ||
| * [**Asterisk**](https://www.asterisk.org/) - Asterisk is a software implementation of a telephone private branch exchange (PBX) (Supported Versions 13 through 20). - [GPL License](https://www.gnu.org/licenses/gpl-3.0.en.html) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Asterisk is not a PHP library.
|
|
||
| This project leverages a variety of robust PHP libraries for its backend functionality. Below is a list of the primary dependencies, along with their licenses and project links for further information. | ||
|
|
||
| * [**Alchemy/Zippy**](https://github.com/alchemy-fr/zippy) (~0.4.9) - [MIT License](https://github.com/alchemy-fr/zippy/blob/master/LICENSE) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why tilde ? Are you guessing what version is used ?
| * [doctrine/orm](https://www.doctrine-project.org/) | ||
| * [**Filp/Whoops**](https://filp.github.io/whoops/) (~2.3.0) - [MIT License](https://github.com/filp/whoops/blob/master/LICENSE) | ||
| * [**Fightbulc/Moment**](https://moment.github.io/moment/) (~1.27.0) - [MIT License](https://github.com/fightbulc/moment/blob/master/LICENSE) | ||
| * [**Giggsey/Libphonenumber-For-Php**](https://github.com/giggsey/libphonenumber-for-php) (^8.10.6) - [Apache License 2.0](https://github.com/giggsey/libphonenumber-for-php/blob/master/LICENSE) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why carrot ? Where specifically in the module is that referenced ?
| * [Typeahead] - a flexible JavaScript library that provides a strong foundation for building robust typeaheads. License MIT | ||
| * [zxcvbn] - Realistic password strength estimation - Dan Wheeler (Dropbox). License MIT | ||
|
|
||
| This project utilizes various frontend libraries to enhance the user experience. Version numbers, where available, are inferred from the provided asset folder information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A link to the asset for users to do their own assessment of the version would be preferable to inaccurate inference.
| This project utilizes various frontend libraries to enhance the user experience. Version numbers, where available, are inferred from the provided asset folder information. | ||
|
|
||
| * [**Bootstrap Table**](https://bootstrap-table.com/) (v1.9.0 - inferred) - An extended Bootstrap table with radio, checkbox, sort, pagination, and other added features. - [MIT License](https://github.com/wenzhixin/bootstrap-table/blob/master/LICENSE) | ||
| * [**Chosen**](https://harvesthq.github.io/chosen/) (v1.6.2 - inferred) - Chosen is a jQuery plugin that makes long, unwieldy select boxes much more user-friendly. - [MIT License](https://github.com/harvesthq/chosen/blob/master/LICENSE.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you using ~ tilde and ^ carrot in one part of the file ? But now inferred here ? Or are they different things ?
| #### Music | ||
|
|
||
| * [reno_project-system] - Reno Project, renoproject@hotmail.com | ||
| FreePBX incorporates several royalty-free, Creative Commons licensed music files. These files are distributed under the Creative Commons Attribution-ShareAlike 3.0 license through explicit permission from their authors. The license can be found at: [http://creativecommons.org/licenses/by-sa/3.0/](http://creativecommons.org/licenses/by-sa/3.0/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing the link to the files may violate the CC SA 3.0 license "appropriate credit" clause. Why did you do this ?
|
|
||
| Installation | ||
| -------------- | ||
| * **macroform-cold\_day** - Paul Shuler (Macroform), paulshuler@gmail.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are links to the material no longer available ?
| [typeahead]: https://twitter.github.io/typeahead.js/ | ||
| [PHP Data Objects]: http://php.net/manual/en/intro.pdo.php | ||
| [Asterisk (PBX)]: http://www.asterisk.org | ||
| *Free Software, Hell Yeah!* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Free Software, Thank God!" would be better IMHO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This goes back to the origin of the project. When there was an open source culture. If you review the code base there a lot of little Easter eggs. In any case "God" may offend some to ¯_(ツ)_/¯
Realistically this was done as a POC and needs to be done to every branch. Let me see if I can build a generator for this using the composer/packagist API for most up to date info. I will add it to dev-tools. This should be done every time the composer libs are updated or a new branch is created. Best would be to make a github action to watch
on:
push:
branches:
- release/*
paths:
- 'amp_conf/htdocs/admin/libraries/Composer/composer.json'
```
Make current for FreePBX 16 stack, This needs to be done for 17 too.