Skip to content

Commit

Permalink
doc improves
Browse files Browse the repository at this point in the history
  • Loading branch information
@rodber
rodber committed Oct 22, 2023
1 parent f5a072f commit b907942
Show file tree
Hide file tree
Showing 9 changed files with 133 additions and 32 deletions.
6 changes: 3 additions & 3 deletions .vuepress/config-project.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ module.exports = {
themeConfig: {
logo: '/logo.svg',
pwa: false,
repo: 'chevere/xrdebug',
docsRepo: 'chevere/xrdebug-docs',
repo: 'xrdebug/xrdebug',
docsRepo: 'xrdebug/xrdebug-docs',
docsBranch: 'main',
smoothScroll: false,
editLinks: true,
Expand All @@ -41,7 +41,7 @@ module.exports = {
text: 'Library',
ariaLabel: 'Library Menu',
items: [
{ text: 'PHP', link: 'https://github.com/chevere/xr' },
{ text: 'PHP', link: 'https://github.com/xrdebug/php' },
]
}
]
Expand Down
Binary file modified .vuepress/public/logo.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions .vuepress/styles/index.styl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
* ref：https://vuepress.vuejs.org/config/#index-styl
*/

video {
object-fit: cover;
}
24 changes: 13 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,25 @@ actionLink: /install/
---

::: slot footer
Apache 2.0 Licensed | Copyright © 2023-present [Rodolfo Berrios](https://rodolfoberrios.com)
Apache 2.0 Licensed | Copyright © [Rodolfo Berrios](https://rodolfoberrios.com)
:::

<video width="100%" poster="./src/social/github.jpg" controls>
<source src="./src/video/cremino.mp4" type="video/mp4">
</video>

# Quick start

* [Install](/install) server software
* [Run](run/README.md) `xrdebug` on your terminal
* [Install](/install) command
* [Run](run/README.md) `xrdebug`
* Install a client library for your language

## Client libraries
## Demo

| Language | Package |
| -------- | ------------------------------------------------------- |
| PHP | [chevere/xr](https://packagist.org/packages/chevere/xr) |
<video width="100%" poster="./src/social/xrdebug-social.png" controls>
<source src="./src/video/cremino.mp4" type="video/mp4">
</video>

## Client libraries

👍 To contribute a client library check the [developer guide](/developer) and the [API](/api).

| Language | Package |
| --------------------------------------------------------- | --------------------------------------------------------- |
| <img src="./src/tech/php.svg" alt="drawing" width="140"/> | [xrdebug/php](https://packagist.org/packages/xrdebug/php) |
2 changes: 1 addition & 1 deletion api/spec.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Specification

xrDebug uses [Schwager](https://chevere.org/packages/schwager.html) for describing its HTTP API. The [schwager.json](https://github.com/chevere/xrdebug/releases/latest/download/schwager.json) file is available since `1.0`.
xrDebug uses [Schwager](https://chevere.org/packages/schwager.html) for describing its HTTP API. The [schwager.json](https://github.com/xrdebug/xrdebug/releases/latest/download/schwager.json) file is available since `1.0`.

* All parameters required except if `required: false`

Expand Down
34 changes: 17 additions & 17 deletions install/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,23 @@ Download latest `xrdebug` binary for your operating system and CPU architecture.

| CPU | Download |
| ------- | ---------------------------------------------------------------------------------------------------------------- |
| Silicon | [xrdebug-macos-arm64.pkg](https://github.com/chevere/xrdebug/releases/latest/download/xrdebug-macos-arm64.pkg) |
| Intel | [xrdebug-macos-x86_64.pkg](https://github.com/chevere/xrdebug/releases/latest/download/xrdebug-macos-x86_64.pkg) |
| Silicon | [xrdebug-macos-arm64.pkg](https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug-macos-arm64.pkg) |
| Intel | [xrdebug-macos-x86_64.pkg](https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug-macos-x86_64.pkg) |

::: details CLI instructions
Run the following to install from your terminal:

<code-group>
<code-block title="Silicon">
```sh
curl -LO https://github.com/chevere/xrdebug/releases/latest/download/xrdebug-macos-arm64.pkg
curl -LO https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug-macos-arm64.pkg
open xrdebug-macos-arm64.pkg
```
</code-block>

<code-block title="Intel">
```sh
curl -LO https://github.com/chevere/xrdebug/releases/latest/download/xrdebug-macos-x86_64.pkg
curl -LO https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug-macos-x86_64.pkg
open xrdebug-macos-x86_64.pkg
```
</code-block>
Expand All @@ -35,23 +35,23 @@ open xrdebug-macos-x86_64.pkg

| CPU | Download |
| ------- | ------------------------------------------------------------------------------------------------------------------------ |
| aarch64 | [xrdebug-linux-aarch64.tar.gz](https://github.com/chevere/xrdebug/releases/latest/download/xrdebug-linux-aarch64.tar.gz) |
| x86_64 | [xrdebug-linux-x86_64.tar.gz](https://github.com/chevere/xrdebug/releases/latest/download/xrdebug-linux-x86_64.tar.gz) |
| aarch64 | [xrdebug-linux-aarch64.tar.gz](https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug-linux-aarch64.tar.gz) |
| x86_64 | [xrdebug-linux-x86_64.tar.gz](https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug-linux-x86_64.tar.gz) |

::: details CLI instructions
Run the following to install from your terminal:

<code-group>
<code-block title="aarch64">
```sh
curl -LO https://github.com/chevere/xrdebug/releases/latest/download/xrdebug-linux-aarch64.tar.gz
curl -LO https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug-linux-aarch64.tar.gz
tar -xvf xrdebug-linux-aarch64.tar.gz
```
</code-block>

<code-block title="x86_64">
```sh
curl -LO https://github.com/chevere/xrdebug/releases/latest/download/xrdebug-linux-x86_64.tar.gz
curl -LO https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug-linux-x86_64.tar.gz
tar -xvf xrdebug-linux-x86_64.tar.gz
```
</code-block>
Expand All @@ -60,15 +60,15 @@ tar -xvf xrdebug-linux-x86_64.tar.gz

## PHAR

Download latest [xrdebug.phar](https://github.com/chevere/xrdebug/releases/latest/download/xrdebug.phar) file.
Download latest [xrdebug.phar](https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug.phar) file.

::: details CLI instructions
To download and verify from terminal:

```sh
# download
curl -LO https://github.com/chevere/xrdebug/releases/latest/download/xrdebug.phar
curl -LO https://github.com/chevere/xrdebug/releases/latest/download/xrdebug.phar.asc
curl -LO https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug.phar
curl -LO https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug.phar.asc
# verify
gpg --recv-keys 75BD018B5EB1DAC838C358414B997D0D617BB354
gpg --with-fingerprint --verify xrdebug.phar.asc xrdebug.phar
Expand All @@ -78,10 +78,10 @@ gpg --with-fingerprint --verify xrdebug.phar.asc xrdebug.phar

## Source

To install from source clone the [repository](https://github.com/chevere/xrdebug):
To install from source clone the [repository](https://github.com/xrdebug/xrdebug):

```sh
git clone https://github.com/chevere/xrdebug.git
git clone https://github.com/xrdebug/xrdebug.git
```

Install dependencies using Composer:
Expand All @@ -98,10 +98,10 @@ The command will be available at:

## Packagist

Use package [chevere/xrdebug](https://packagist.org/packages/chevere/xrdebug) to install as a dependency for your project using Composer:
Use package [xrdebug/xrdebug](https://packagist.org/packages/xrdebug/xrdebug) to install as a dependency for your project using Composer:

```sh
composer require --dev chevere/xrdebug
composer require --dev xrdebug/xrdebug
```

The dependency server will be available at:
Expand All @@ -112,10 +112,10 @@ vendor/bin/xrdebug

## Docker

Container images are available at [ghcr.io/chevere/xrdebug](https://github.com/chevere/xrdebug/pkgs/container/xrdebug).
Container images are available at [ghcr.io/xrdebug/xrdebug](https://github.com/xrdebug/xrdebug/pkgs/container/xrdebug).

Run the following command to start the server at port `27420`:

```sh
docker run -t --init --rm -p 27420:27420 ghcr.io/chevere/xrdebug
docker run -t --init --rm -p 27420:27420 ghcr.io/xrdebug/xrdebug
```
Binary file removed src/social/github.jpg
View file
Binary file not shown.
Binary file added src/social/xrdebug-social.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
96 changes: 96 additions & 0 deletions src/tech/php.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b907942

Please sign in to comment.