Skip to content

Commit ec17d26

Browse files
committed
doc: Fix typos
1 parent 4aa4867 commit ec17d26

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ To propose new components, it is necessary to open a [Pull Request](https://gith
1515

1616
To do it, there is currently two methods.
1717

18-
### 1 - Add an entry to the CI (prefered method)
18+
### 1 - Add an entry to the CI (preferred method)
1919
For most components, new stable versions (and experimental builds if they exist) are automatically pulled. This is accomplished by the [pull-components.yml](https://github.com/bottlesdevs/components/blob/main/.github/workflows/pull-components.yml) workflow, where components are described in the following format:
2020

2121
```yaml
@@ -31,13 +31,13 @@ Sub-category: "",
3131
```
3232
where:
3333
- **repo** is the GitHub repository in the format `owner/repository`
34-
- **workflow** is the workflow filename used to generate exerimental builds, if any
35-
- **branch** is the **workflow** branch used to generate exerimental builds, if any
36-
- **name-prefix** is used to generate the full name of the component using **name-prefix** + `version` + **name-suffix** (e.g. `dxvk-` + `2.0` + ∅), and look for release/experimental asset whose filename is begining by **name-prefix**
37-
- **name-suffix** serves the exact same purpose as **name-prefix**, is only used when multiple variants are available for one component (e.g. `-x86`, `-x64`, etc)
38-
- **version-prefix** is used to find the latest release version whose [tag](https://github.com/doitsujin/dxvk/tags) is begining by **version-prefix**, and to remove **version-prefix** from the final `version` string (e.g. `v2.0` will become `2.0`)
34+
- **workflow** is the workflow filename used to generate experimental builds, if any
35+
- **branch** is the **workflow** branch used to generate experimental builds, if any
36+
- **name-prefix** is used to generate the full name of the component using **name-prefix** + `version` + **name-suffix** (e.g. `dxvk-` + `2.0` + ∅), and look for release/experimental asset whose filename is beginning by **name-prefix**
37+
- **name-suffix** serves the exact same purpose as **name-prefix**, is only used when multiple variants are available for one component (e.g. `-x86`, `-x64`, etc.)
38+
- **version-prefix** is used to find the latest release version whose [tag](https://github.com/doitsujin/dxvk/tags) is beginning by **version-prefix**, and to remove **version-prefix** from the final `version` string (e.g. `v2.0` will become `2.0`)
3939
- **yaml-file** is the YAML component filename located in the [input_files](https://github.com/bottlesdevs/components/blob/main/input_files) directory
40-
- **Category** and **Sub-category** are repectively the Category and Sub-category as described in the **yaml-file** (e.g. [14-dxvk.yml](https://github.com/bottlesdevs/components/blob/main/input_files/14-dxvk.yml))
40+
- **Category** and **Sub-category** are respectively the Category and Sub-category as described in the **yaml-file** (e.g. [14-dxvk.yml](https://github.com/bottlesdevs/components/blob/main/input_files/14-dxvk.yml))
4141

4242
### 2 - Manually (legacy method)
4343
Each poster must follow the following layout:
@@ -51,9 +51,7 @@ File:
5151
file_checksum: 659ee0ee3dbe5274825734ad19692e12
5252
rename: caffe-7.2-x86_64.tar.xz
5353
```
54-
old json manifests can be converted using this [online tool](https://www.json2yaml.com).
55-
56-
where:
54+
Old JSON manifests can be converted using this [online tool](https://www.json2yaml.com), where:
5755
- **Name** is a name without spaces, including version, of the component (must reflect the name of the manifest file)
5856
- **Provider** is the name of the component supplier (not the maintainer)
5957
- **Channel** should be stable or unstable
@@ -74,9 +72,9 @@ Post:
7472

7573
We provide an [automatic tools](https://github.com/bottlesdevs/tools/blob/main/MaintainersHelpers/component-generator.py) for generating the manifest.
7674

77-
In addition to the manifest, en entry must be created in the corresponding file located in the [input_files](https://github.com/bottlesdevs/components/blob/main/input_files) directory. The index can then be regenerated using the [generate_index.sh](https://github.com/bottlesdevs/components/blob/main/generate_index.sh) script.
75+
In addition to the manifest, an entry must be created in the corresponding file located in the [input_files](https://github.com/bottlesdevs/components/blob/main/input_files) directory. The index can then be regenerated using the [generate_index.sh](https://github.com/bottlesdevs/components/blob/main/generate_index.sh) script.
7876

79-
Please double check and test using the `LOCAL_COMPONENTS=/path/to/components flatpak run com.usebottles.bottles` command before open a pull request.
77+
Please double-check and test using the `LOCAL_COMPONENTS=/path/to/components flatpak run com.usebottles.bottles` command before open a pull request.
8078

8179
### Guidelines
8280
The sources of the components must be public and searchable and must not infringe any copyright. Also, each archive must contain the compiled version and not the source code.

0 commit comments

Comments
 (0)