diff options
| author | 2022-01-08 21:58:55 +0100 | |
|---|---|---|
| committer | 2022-01-08 21:58:55 +0100 | |
| commit | 1acd3ab09be1b65bfd6122ee351490c3b5527bb8 (patch) | |
| tree | f11de558e7a09522a45d1c155d9707ecda6bf1eb /docs/en/developers/02_First_steps.md | |
| parent | 916df412f5b6f7fb9bcfb705a3c8c23e35304410 (diff) | |
Use typographic quotes (#4133)
* Use typographic quotes
* A few fixes
* Fix
* Fix not saved
* Implement feedback
* Detail
* Revert spoken English fixes
Left for a future dedicated discussion
* More reverts
* Final reverts
* Final minor
Diffstat (limited to 'docs/en/developers/02_First_steps.md')
| -rw-r--r-- | docs/en/developers/02_First_steps.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/en/developers/02_First_steps.md b/docs/en/developers/02_First_steps.md index 626ee84fc..e79d86691 100644 --- a/docs/en/developers/02_First_steps.md +++ b/docs/en/developers/02_First_steps.md @@ -1,16 +1,16 @@ # Environment configuration (Docker) -FreshRSS is built with PHP and uses a homemade framework, Minz. The dependencies are directly included in the source code, so you don't need Composer. +FreshRSS is built with PHP and uses a homemade framework, Minz. The dependencies are directly included in the source code, so you don’t need Composer. -There are various ways to configure your development environment. The easiest and most supported method is based on Docker, which is the solution documented below. If you already have a working PHP environment, you probably don't need it. +There are various ways to configure your development environment. The easiest and most supported method is based on Docker, which is the solution documented below. If you already have a working PHP environment, you probably don’t need it. -We assume here that you use a GNU/Linux distribution, capable of running Docker. Otherwise, you'll have to adapt the commands accordingly. +We assume here that you use a GNU/Linux distribution, capable of running Docker. Otherwise, you’ll have to adapt the commands accordingly. -The commands that follow have to be executed in a console. They start by `$` when commands need to be executed as normal user, and by `#` when they need to be executed as root user. You don't have to type these characters. A path may be indicated before these characters to help you identify where they need to be executed. For instance, `app$ echo 'Hello World'` indicates that you have to execute `echo` command in the `app/` directory. +The commands that follow have to be executed in a console. They start by `$` when commands need to be executed as normal user, and by `#` when they need to be executed as root user. You don’t have to type these characters. A path may be indicated before these characters to help you identify where they need to be executed. For instance, `app$ echo 'Hello World'` indicates that you have to execute `echo` command in the `app/` directory. First, you need to install [Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/). -Once you're done, clone the repository with: +Once you’re done, clone the repository with: ```sh git clone https://github.com/FreshRSS/FreshRSS.git @@ -25,7 +25,7 @@ Then, the only command you need to know is the following: make start ``` -This might take some time while Docker downloads the image. If your user isn't in the `docker` group, you'll need to prepend the command with `sudo`. +This might take some time while Docker downloads the image. If your user isn’t in the `docker` group, you’ll need to prepend the command with `sudo`. **You can now access FreshRSS at [http://localhost:8080](http://localhost:8080).** Just follow the install process and select the SQLite database. @@ -35,7 +35,7 @@ You can stop the containers by typing <kbd>Control</kbd> + <kbd>c</kbd> or with make stop ``` -If you're interested in the configuration, the `make` commands are defined in the [`Makefile`](/Makefile). +If you’re interested in the configuration, the `make` commands are defined in the [`Makefile`](/Makefile). If you need to use a different tag image (default is `alpine`), you can set the `TAG` environment variable: @@ -65,9 +65,9 @@ If you want to create your own FreshRSS extension, take a look at the [extension ## Coding style -If you want to contribute to the source code, it's important to follow the project's coding style. The actual code doesn't always follow it throughout the project, but we should fix it every time an opportunity presents itself. +If you want to contribute to the source code, it’s important to follow the project’s coding style. The actual code doesn’t always follow it throughout the project, but we should fix it every time an opportunity presents itself. -Contributions which don't follow the coding style will be rejected as long as the coding style is not fixed. +Contributions which don’t follow the coding style will be rejected as long as the coding style is not fixed. ## Spaces, tabs and other whitespace characters @@ -119,7 +119,7 @@ echo $a ? 1 : 0; ### Parentheses -There should be no spaces in between brackets. There should be no spaces before the opening bracket, except if it's after a keyword. There shouldn't be any spaces after the closing bracket, except if it's followed by a curly bracket. +There should be no spaces in between brackets. There should be no spaces before the opening bracket, except if it’s after a keyword. There shouldn’t be any spaces after the closing bracket, except if it’s followed by a curly bracket. ```php if ($a == 10) { @@ -133,7 +133,7 @@ if ((int)$a == 10) { ### With chained functions -It happens most of the time in Javascript files. When there are chained functions with closures and callback functions, it's hard to understand the code if not properly formatted. In those cases, we add a new indent level for the complete instruction and reset the indent for a new instruction on the same level. +It happens most of the time in Javascript files. When there are chained functions with closures and callback functions, it’s hard to understand the code if not properly formatted. In those cases, we add a new indent level for the complete instruction and reset the indent for a new instruction on the same level. ```javascript // First instruction |
