From ccd7240c5bf35ca880e64791c1ef95a2d59f7fd0 Mon Sep 17 00:00:00 2001 From: aronson Date: Sun, 27 Aug 2023 23:54:05 -0500 Subject: [PATCH 1/4] Update README.md --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c9683cd..70328b7 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,27 @@ ## Installation and usage -**Note**: discord-irc requires Deno, as it depends on [discord.js](https://github.com/hydrabolt/discord.js). -Future versions may require newer Deno versions, though we should support active releases. -Please see the [official install instructions](https://deno.land/manual/getting_started/installation) to install Deno for your platform. - Before you can run discord-irc you need to create a configuration file by following the instructions [here](https://github.com/aronson/discord-irc#configuration). Place config.json in the same directory as the cloned sources. -When you've done that you can install and start the bot through cloning the repository: +When you've done that you can install and start the bot by downloading the [latest release](https://github.com/aronson/discord-irc/releases) for your platform. + +Windows: +```batch +.\discord-irc-windows-x86_64.exe -c C:\Path\To\config.json +``` + +Linux/macOS (make sure to replace the name of the program file with the one you downloaded): +```bash +## Linux +./discord-irc-linux-x86_64 -c /path/to/config.json +``` + +**Note**: For *development* work, discord-irc requires Deno, as it depends on [Harmony](https://harmony.mod.land). +Please see the [official install instructions](https://deno.land/manual/getting_started/installation) to install Deno for your platform. + +One can also run the bot for development purposes through cloning the repository: ```bash ## Clone the repo From e8bf15a3d9681a0c0a9757e9087116764adb2c5e Mon Sep 17 00:00:00 2001 From: aronson Date: Sun, 27 Aug 2023 23:56:24 -0500 Subject: [PATCH 2/4] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 70328b7..ec570b2 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,10 @@ Linux/macOS (make sure to replace the name of the program file with the one you ```bash ## Linux ./discord-irc-linux-x86_64 -c /path/to/config.json +## Apple users may need to mark as executable and disable quarantine before running +chmod +x ./discord-irc-apple-* +xattr -c ./discord-irc-apple-* +./discord-irc-apple-* -c /path/to/config.json ``` **Note**: For *development* work, discord-irc requires Deno, as it depends on [Harmony](https://harmony.mod.land). From dbbb3bc56b5aab4051972631aa6c70f74d04d0c0 Mon Sep 17 00:00:00 2001 From: aronson Date: Sun, 27 Aug 2023 23:58:28 -0500 Subject: [PATCH 3/4] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ec570b2..2cf0a33 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,8 @@ Before you can run discord-irc you need to create a configuration file by following the instructions [here](https://github.com/aronson/discord-irc#configuration). Place config.json in the same directory as the cloned sources. -When you've done that you can install and start the bot by downloading the [latest release](https://github.com/aronson/discord-irc/releases) for your platform. +## Native builds (easiest) +Start the bot by downloading the [latest release](https://github.com/aronson/discord-irc/releases) for your platform. Windows: ```batch @@ -29,11 +30,10 @@ xattr -c ./discord-irc-apple-* ./discord-irc-apple-* -c /path/to/config.json ``` -**Note**: For *development* work, discord-irc requires Deno, as it depends on [Harmony](https://harmony.mod.land). +## Running with Deno (developers) +For *development* work, discord-irc requires Deno, as it depends on [Harmony](https://harmony.mod.land). Please see the [official install instructions](https://deno.land/manual/getting_started/installation) to install Deno for your platform. -One can also run the bot for development purposes through cloning the repository: - ```bash ## Clone the repo git clone https://github.com/aronson/discord-irc.git @@ -56,7 +56,7 @@ import config from './config.json'; discordIRC(config); ``` -## Docker +### Docker As an alternative to running discord-irc directly on your machine, we provide a Docker container image. After creating a configuration file, you can fetch the image from Docker Hub and run it with the following command: From 650da6d43d995b6a333daf35b9a4ceabba90bb84 Mon Sep 17 00:00:00 2001 From: aronson Date: Sun, 27 Aug 2023 23:58:46 -0500 Subject: [PATCH 4/4] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2cf0a33..aca2ceb 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Before you can run discord-irc you need to create a configuration file by following the instructions [here](https://github.com/aronson/discord-irc#configuration). Place config.json in the same directory as the cloned sources. -## Native builds (easiest) +### Native builds (easiest) Start the bot by downloading the [latest release](https://github.com/aronson/discord-irc/releases) for your platform. Windows: @@ -30,7 +30,7 @@ xattr -c ./discord-irc-apple-* ./discord-irc-apple-* -c /path/to/config.json ``` -## Running with Deno (developers) +### Running with Deno (developers) For *development* work, discord-irc requires Deno, as it depends on [Harmony](https://harmony.mod.land). Please see the [official install instructions](https://deno.land/manual/getting_started/installation) to install Deno for your platform.