From 6f5d765366f496267e0d7d42d7dc287d98bf7361 Mon Sep 17 00:00:00 2001 From: George Steel Date: Wed, 16 Oct 2024 16:17:07 +0100 Subject: [PATCH] Readme Linting Fixes Signed-off-by: George Steel --- README.md | 53 ++++++++++++++++++++++------------------------------- 1 file changed, 22 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 4207246..3d1acab 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ # laminas-mvc-skeleton > ## πŸ‡·πŸ‡Ί Русским Π³Ρ€Π°ΠΆΠ΄Π°Π½Π°ΠΌ -> +> > ΠœΡ‹, участники Laminas, Ρ€ΠΎΠ΄ΠΈΠ»ΠΈΡΡŒ ΠΈ ΠΆΠΈΠ²Π΅ΠΌ Π² Ρ€Π°Π·Π½Ρ‹Ρ… странах. Π£ ΠΌΠ½ΠΎΠ³ΠΈΡ… ΠΈΠ· нас Π΅ΡΡ‚ΡŒ Π΄Ρ€ΡƒΠ·ΡŒΡ, родствСнники ΠΈ ΠΊΠΎΠ»Π»Π΅Π³ΠΈ ΠΊΠ°ΠΊ Π² России, Ρ‚Π°ΠΊ ΠΈ Π² Π£ΠΊΡ€Π°ΠΈΠ½Π΅. НСкоторыС ΠΈΠ· нас Ρ€ΠΎΠ΄ΠΈΠ»ΠΈΡΡŒ Π² России. НСкоторыС ΠΈΠ· нас ΠΆΠΈΠ²ΡƒΡ‚ Π² России. Π£ Π½Π΅ΠΊΠΎΡ‚ΠΎΡ€Ρ‹Ρ… Π±Π°Π±ΡƒΡˆΠΊΠΈ ΠΈ Π΄Π΅Π΄ΡƒΡˆΠΊΠΈ ΡΡ€Π°ΠΆΠ°Π»ΠΈΡΡŒ с Ρ„Π°ΡˆΠΈΡΡ‚Π°ΠΌΠΈ Π²ΠΎ Π’Ρ‚ΠΎΡ€ΠΎΠΉ ΠΌΠΈΡ€ΠΎΠ²ΠΎΠΉ Π²ΠΎΠΉΠ½Π΅. Π—Π΄Π΅ΡΡŒ Π½ΠΈΠΊΡ‚ΠΎ Π½Π΅ ΠΏΠΎΠ΄Π΄Π΅Ρ€ΠΆΠΈΠ²Π°Π΅Ρ‚ Ρ„Π°ΡˆΠΈΠ·ΠΌ. -> +> > Π£ ΠΎΠ΄Π½ΠΎΠ³ΠΎ ΠΈΠ· нас Π΅ΡΡ‚ΡŒ украинская родствСнница, которая спаслась ΠΈΠ· Π΄ΠΎΠΌΠ° вмСстС с сыном. ПоСзд задСрТался ΠΈΠ·-Π·Π° Π±ΠΎΠΌΠ±Π΅ΠΆΠΊΠΈ Π½Π° Π΄ΠΎΡ€ΠΎΠ³Π΅ Π²ΠΏΠ΅Ρ€Π΅Π΄ΠΈ. Π£ нас Π΅ΡΡ‚ΡŒ Π΄Ρ€ΡƒΠ·ΡŒΡ, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹Π΅ прячутся Π² Π±ΠΎΠΌΠ±ΠΎΡƒΠ±Π΅ΠΆΠΈΡ‰Π°Ρ…. ΠœΡ‹ с Ρ‚Ρ€Π΅Π²ΠΎΠ³ΠΎΠΉ ΠΆΠ΄Π΅ΠΌ вСсточки ΠΎΡ‚ Π½ΠΈΡ… послС Π²ΠΎΠ·Π΄ΡƒΡˆΠ½Ρ‹Ρ… Π½Π°Π»Π΅Ρ‚ΠΎΠ², ΠΊΠΎΡ‚ΠΎΡ€Ρ‹Π΅ бСспорядочно наносят ΡƒΠ΄Π°Ρ€Ρ‹ ΠΈ ΠΏΠΎΠΏΠ°Π΄Π°ΡŽΡ‚ ΠΏΠΎ Π±ΠΎΠ»ΡŒΠ½ΠΈΡ†Π°ΠΌ, школам, дСтским садам ΠΈ Π΄ΠΎΠΌΠ°ΠΌ. ΠœΡ‹ Π½Π΅ Π±Π΅Ρ€Π΅ΠΌ это ΠΈΠ· ΠΊΠ°ΠΊΠΈΡ…-Π»ΠΈΠ±ΠΎ БМИ. ΠœΡ‹ наблюдаСм это Π½Π°ΠΏΡ€ΡΠΌΡƒΡŽ. -> +> > Π’Ρ‹ довСряСтС Π½Π°ΠΌ достаточно, Ρ‡Ρ‚ΠΎΠ± ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ наши ΠΏΡ€ΠΎΠ³Ρ€Π°ΠΌΠΌΡ‹, ΠΈ ΠΌΡ‹ просим вас Π΄ΠΎΠ²Π΅Ρ€ΠΈΡ‚ΡŒΡΡ Π½Π°ΠΌ вновь. ΠœΡ‹ нуТдаСмся Π² ΠΏΠΎΠΌΠΎΡ‰ΠΈ. Π’Ρ‹Ρ…ΠΎΠ΄ΠΈΡ‚Π΅ ΠΈ протСстуйтС ΠΏΡ€ΠΎΡ‚ΠΈΠ² этой бСсполСзной Π²ΠΎΠΉΠ½Ρ‹. ΠžΡΡ‚Π°Π½ΠΎΠ²ΠΈΡ‚Π΅ ΠΊΡ€ΠΎΠ²ΠΎΠΏΡ€ΠΎΠ»ΠΈΡ‚ΠΈΠ΅. Π‘ΠΊΠ°ΠΆΠΈΡ‚Π΅ "НСт Π²ΠΎΠΉΠ½Π΅!" -> +> > ## πŸ‡ΊπŸ‡Έ To Citizens of Russia -> +> > We at Laminas come from all over the world. Many of us have friends, family and colleagues in both Russia and Ukraine. Some of us were born in Russia. Some of us currently live in Russia. Some have grandparents who fought Nazis in World War II. Nobody here supports fascism. -> +> > One team member has a Ukrainian relative who fled her home with her son. The train was delayed due to bombing on the road ahead. We have friends who are hiding in bomb shelters. We anxiously follow up on them after the air raids, which indiscriminately fire at hospitals, schools, kindergartens and houses. We're not taking this from any media. These are our actual experiences. -> +> > You trust us enough to use our software. We ask that you trust us to say the truth on this. We need your help. Go out and protest this unnecessary war. Stop the bloodshed. Say "stop the war!" ## Introduction @@ -43,9 +43,8 @@ $ php -S 0.0.0.0:8080 -t public $ composer serve ``` -This will start the cli-server on port 8080, and bind it to all network -interfaces. You can then visit the site at http://localhost:8080/ -- which will bring up Laminas MVC Skeleton welcome page. +This will start the cli-server on port 8080, and bind it to all network interfaces. +You can then visit the site at http://localhost:8080/ which will bring up Laminas MVC Skeleton welcome page. **Note:** The built-in CLI server is *for development only*. @@ -97,7 +96,7 @@ control. (If you want to make the modifications permanent, edit the ## Running Psalm Static Analysis To run the supplied skeleton static analysis, you need to do one of the following: -It is recommended to install the test components from laminas (laminas/laminas-test), +It is recommended to install the test components from laminas (laminas/laminas-test), as this is used in the tests supplied. ```bash @@ -112,10 +111,8 @@ $ composer static-analysis ## Using docker-compose -This skeleton provides a `docker-compose.yml` for use with -[docker-compose](https://docs.docker.com/compose/); it -uses the provided `Dockerfile` to build a docker image -for the `laminas` container created with `docker-compose`. +This skeleton provides a `docker-compose.yml` for use with [docker-compose](https://docs.docker.com/compose/); +it uses the provided `Dockerfile` to build a docker image for the `laminas` container created with `docker-compose`. Build and start the image and container using: @@ -125,19 +122,16 @@ $ docker-compose up -d --build At this point, you can visit http://localhost:8080 to see the site running. -You can also run commands such as `composer` in the container. The container -environment is named "laminas" so you will pass that value to -`docker-compose run`: +You can also run commands such as `composer` in the container. +The container environment is named "laminas" so you will pass that value to `docker-compose run`: ```bash $ docker-compose run laminas composer install ``` -Some composer packages optionally use additional PHP extensions. -The Dockerfile contains several commented-out commands -which enable some of the more popular php extensions. -For example, to install `pdo-pgsql` support for `laminas/laminas-db` -uncomment the lines: +Some composer packages optionally use additional PHP extensions. +The Dockerfile contains several commented-out commands which enable some of the more popular php extensions. +For example, to install `pdo-pgsql` support for `laminas/laminas-db` uncomment the lines: ```sh # RUN apt-get install --yes libpq-dev \ @@ -153,8 +147,8 @@ then re-run the `docker-compose up -d --build` line as above. ### Apache setup -To setup apache, setup a virtual host to point to the public/ directory of the -project and you should be ready to go! It should look something like below: +To setup apache, setup a virtual host to point to the public/ directory of the project and you should be ready to go! +It should look something like below: ```apache @@ -174,9 +168,7 @@ project and you should be ready to go! It should look something like below: ### Nginx setup -To setup nginx, open your `/path/to/nginx/nginx.conf` and add an -[include directive](http://nginx.org/en/docs/ngx_core_module.html#include) below -into `http` block if it does not already exist: +To setup nginx, open your `/path/to/nginx/nginx.conf` and add an [include directive](http://nginx.org/en/docs/ngx_core_module.html#include) below into `http` block if it does not already exist: ```nginx http { @@ -185,9 +177,8 @@ http { } ``` - -Create a virtual host configuration file for your project under `/path/to/nginx/sites-enabled/laminasapp.localhost.conf` -it should look something like below: +Create a virtual host configuration file for your project under `/path/to/nginx/sites-enabled/laminasapp.localhost.conf`. +It should look something like below: ```nginx server {