Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
rodber committed Oct 8, 2023
1 parent 2262437 commit f41f885
Show file tree
Hide file tree
Showing 11 changed files with 146 additions and 182 deletions.
13 changes: 11 additions & 2 deletions .vuepress/config-project.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,17 @@ module.exports = {
repo: 'chevere/xrdebug',
docsRepo: 'chevere/xrdebug-docs',
docsBranch: 'main',
smoothScroll: true,
smoothScroll: false,
editLinks: true,
lastUpdated: true
lastUpdated: true,
nav_after: [
{
text: 'Library',
ariaLabel: 'Library Menu',
items: [
{ text: 'PHP', link: 'https://github.com/chevere/xr' },
]
}
]
},
};
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,15 @@
home: true
heroImage: /logo.svg
heroText: xrDebug
tagline: Lightweight debug utility
actionText: Introduction →
actionLink: /introduction/
features:
- title: Easy to use
details: Full-featured with a gorgeous user interface.
- title: Portable & HTML based
details: One-click disposable server run.
- title: Beautiful
details: Yet another debugger, but it looks danky!
footer: Made by Rodolfo Berrios
tagline: Lightweight portable debug utility
actionText: Install →
actionLink: /install/
---

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

<video width="100%" poster="./src/social/github.jpg" controls>
<source src="./src/video/cremino.mp4" type="video/mp4">
</video>
Expand All @@ -23,10 +19,12 @@ footer: Made by Rodolfo Berrios

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

## Client libraries

| Language | Package |
| -------- | ------------------------------------------------------- |
| PHP | [chevere/xr](https://packagist.org/packages/chevere/xr) |

To contribute a client library check the [developer guide](developer/) and our [API](/api).
👍 To contribute a client library check the [developer guide](/developer) and the [API](/api).
Binary file added bin/linux/aarch64/xrdebug
Binary file not shown.
121 changes: 121 additions & 0 deletions install/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# Installation

## Self-contained binary <Badge text="recommended"/>

Download latest `xrdebug` binary for your operating system and CPU architecture.

### macOS

| 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) |

::: 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
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
open xrdebug-macos-x86_64.pkg
```
</code-block>
</code-group>
:::

### Linux

| 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) |

::: 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
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
tar -xvf xrdebug-linux-x86_64.tar.gz
```
</code-block>
</code-group>
:::

## PHAR

Download latest [xrdebug.phar](https://github.com/chevere/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
# verify
gpg --recv-keys 75BD018B5EB1DAC838C358414B997D0D617BB354
gpg --with-fingerprint --verify xrdebug.phar.asc xrdebug.phar
```

:::

## Source

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

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

Install dependencies using Composer:

```sh
composer install
```

The command will be available at:

```sh
./xrdebug
```

## Packagist

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

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

The dependency server will be available at:

```sh
vendor/bin/xrdebug
```

## Docker

Container images are available at [ghcr.io/chevere/xrdebug](https://github.com/chevere/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
```
64 changes: 0 additions & 64 deletions introduction/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions introduction/contributing.md

This file was deleted.

75 changes: 0 additions & 75 deletions introduction/installation.md

This file was deleted.

7 changes: 0 additions & 7 deletions introduction/naming.php

This file was deleted.

7 changes: 0 additions & 7 deletions introduction/sorting.php

This file was deleted.

2 changes: 1 addition & 1 deletion naming.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php

return [
'introduction/' => 'Intro',
'install/' => 'Install',
'run/' => 'Run',
'api/' => 'API',
'dev/' => 'Developer',
Expand Down
4 changes: 2 additions & 2 deletions sorting.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

return [
'README.md',
'introduction/',
'configuration/',
'install/',
'run/',
'Library',
'developer/',
];

0 comments on commit f41f885

Please sign in to comment.