Skip to content

Commit 4f51e9e

Browse files
authored
Merge pull request #161 from codecov/dana/fix/read-me
Fix read-me
2 parents 69c313e + 982ed80 commit 4f51e9e

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Codecov-cli supports user input. These inputs, along with their descriptions and
5555
# Codecov-cli Commands
5656
| Command | Description |
5757
| :---: | :---: |
58-
| `create-commit` | Saves the commit's metadata in codecov, it's only necessry to run this once per commit
58+
| `create-commit` | Saves the commit's metadata in codecov, it's only necessary to run this once per commit
5959
| `create-report` | Creates an empty report in codecov with initial data e.g. report name, report's commit
6060
| `do-upload` | Searches for and uploads coverage data to codecov
6161
| `create-report-results` | Used for local upload. It tells codecov that you finished local uploading and want it to calculate the results for you to get them locally.
@@ -161,7 +161,7 @@ Codecov-cli supports user input. These inputs, along with their descriptions and
161161
If desired, the CLI can be used as a replacement for our [NodeJS Binary Uploader](https://github.com/codecov/uploader). To use the CLI to upload from your CI workflow, you need to add these commands:
162162

163163
```
164-
pip install codecovcli
164+
pip install codecov-cli
165165
codecovcli create-commit
166166
codecovcli create-report
167167
codecovcli do-upload
@@ -175,7 +175,7 @@ The CLI also supports "dry run" local uploading. This is useful if you prefer to
175175
Local Upload is accomplished as follows:
176176

177177
```
178-
pip install codecovcli
178+
pip install codecov-cli
179179
codecovcli create-commit
180180
codecovcli create-report --code <CODE>
181181
codecovcli do-upload --report-code <CODE>
@@ -216,15 +216,15 @@ pip install -r requirements.txt
216216
python setup.py develop
217217
```
218218

219-
The C code shouldn't require anything additional setup to get running, but depending on your enviroment, you may be prompted to install compilers and supporting tools. If errors are generating during installation, it is likely due to missing dependencies / tools required of the C code. In many cases, resulting error messages should be clear enough to determine what is missing and how to install it, but common errors will be collected here as they are encountered.
219+
The C code shouldn't require any additional setup to get running, but depending on your environment, you may be prompted to install compilers and supporting tools. If errors are generated during installation, it is likely due to missing dependencies / tools required of the C code. In many cases, resulting error messages should be clear enough to determine what is missing and how to install it, but common errors will be collected here as they are encountered.
220220

221221
## Guidelines
222222

223-
There are a few guidelines when developing in this systems. Some notable folders:
223+
There are a few guidelines when developing in this system. Some notable folders:
224224

225225
1. `commands` - It's the folder that interacts with the caller. This is where the commands themselves should reside. These commands are not meant to do heavy lifting. They only do wiring, which is mostly parsing the input parameters.
226-
2. `services` - It's where the heavy logic resides. It's mostly organizaed by which command needs them. Commands should generally be thin wrappers around these services.
227-
3. `helpers` - This is meant for logic that is useful accross different commands. For example, logging helpers, or the logic the searches folders.
226+
2. `services` - It's where the heavy logic resides. It's mostly organized by which command needs them. Commands should generally be thin wrappers around these services.
227+
3. `helpers` - This is meant for logic that is useful across different commands. For example, logging helpers, or the logic that searches folders.
228228

229229
# Releases
230230

0 commit comments

Comments
 (0)