Skip to content

Fix formatting issues in README.md commands #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RealCLanger merged 4 commits into from
Jan 21, 2026
Merged

Fix formatting issues in README.md commands #299

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fea2c63
Fix formatting issues in README.md commands
Web-Dev-Codi Jan 5, 2026
35a5f52
Change code block syntax from console to sh in README.md
Web-Dev-Codi Jan 11, 2026
9ecaa9b
Merge branch 'pytr-org:master' into patch-1
Web-Dev-Codi Jan 21, 2026
cf4bbd7
Update README.md
Web-Dev-Codi Jan 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,26 +35,26 @@ you if you don't already have one.

To install uv on OSX/Linux, run:

```console
$ curl -LsSf https://astral.sh/uv/install.sh | sh
```sh
curl -LsSf https://astral.sh/uv/install.sh | sh
```

On Windows, run:

```console
> powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```sh
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

Then, to run the latest released version of pytr:

```console
$ uvx pytr@latest
```sh
uvx pytr@latest
```

If you want to use the cutting-edge version, use this command instead:

```console
$ uvx --with git+https://github.com/pytr-org/pytr.git pytr
```sh
uvx --with git+https://github.com/pytr-org/pytr.git pytr
```

## Usage
Expand Down Expand Up @@ -109,9 +109,9 @@ device reset - a private key will be generated that pins your "device". The priv
procedure will log you out from your mobile device.

```sh
$ pytr login
$ # or
$ pytr login --phone_no +49123456789 --pin 1234
pytr login
# or
pytr login --phone_no +49123456789 --pin 1234
```

If no arguments are supplied pytr will look for them in the file `~/.pytr/credentials` (the first line must contain
Expand All @@ -123,20 +123,20 @@ the phone number, the second line the pin). If the file doesn't exist pytr will

Clone the repository:

```console
$ git clone https://github.com/pytr-org/pytr.git
```sh
git clone https://github.com/pytr-org/pytr.git
```

Install dependencies:

```console
$ uv sync
```sh
uv sync
```

Run the tests to ensure everything is set up correctly:

```console
$ uv run pytest
```sh
uv run pytest
```

### Linting and Code Formatting
Expand Down Expand Up @@ -171,8 +171,8 @@ checks and type checks.

This readme contains a few automatically generated bits. To keep them up to date, simply run the following command: (Never start it from an activated venv!)

```console
$ uvx mksync@0.1.5 -i README.md
```sh
uvx mksync@0.1.5 -i README.md
```

## License
Expand Down
Loading