Download the PHP package m50/simple without Composer
On this page you can find all versions of the php package m50/simple. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package simple
Short Description The documentation verification tool to make sure that nothing is considered easy or simple.
License MIT
Homepage https://github.com/m50/simple
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package simple
(Not so) Simple
The documentation verification tool to make sure that nothing is considered easy or simple.
Run Simple in your CI process on your documentation to make sure you don't put out any documentation that is condescending or unhelpful to learners. Everywhere that Simple finds any of the problematic words, it may be a perfect case to provide more detailed documentation.
It's like a unit test for your documentation.
Usage
To use simple, run it from the command line providing the directory the documentation files reside in. Example:
To generate the default configuration file, run init:
Then you can just run it:
or specify a specific directory:
To get a full list of options and flags, run the help command:
In CI
In CI, it is recommended to run it like so:
This will force a junit report to be generated, for use in your CI reporting system.
Installation
Simple can either be installed as an executable PHAR, or as a composer dependency.
Alternatively, it can be used with docker for CI builds or locally.
Docker:
The docker image is: marisa50/simple.
To run simple on your docs:
Phar:
Composer
All versions of simple with dependencies
symfony/console Version ^5.0
symfony/finder Version ^5.0
symfony/yaml Version ^5.0