Skip to content

Commit

Permalink
Update installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
rojvv committed Apr 9, 2024
1 parent 856d6b4 commit 9c2140a
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
- [What is MTKruto Server?](#what-is-mtkruto-server)
- [Is this a replacement for Bot API?](#is-this-a-replacement-for-bot-api)
- [Why not just use Bot API?](#why-not-just-use-bot-api)
- [Building from Source](#building-from-source)
- [Installation](#installation)
- [Prebuilt Binaries](#prebuilt-binaries)
- [Building from Source](#building-from-source)
- [CLI Arguments](#cli-arguments)
- [Running](#running)
- [Viewing Statistics](#viewing-statistics)
Expand Down Expand Up @@ -53,11 +55,27 @@ MTKruto Server if they would like to:
issues, since doing so directly with Telegram clients requires logging in each
time, or would otherwise result in errors like AUTH_KEY_DUPLICATED.

## Building from Source
## Installation

### Prebuilt Binaries

To download a prebuilt binary, visit
[here](https://github.com/MTKruto/server/actions/workflows/ci.yml), open the
most recent successful run, and you will see appropriate download links for each
operating system in the Artifacts section.

### Building from Source

To build from source, you need to have [Deno](https://deno.land) installed.
After making sure that it is properly installed, clone the repository, and build
with the following command:
After making sure that it is properly installed, clone the repository
recursively:

```shell
git clone --depth 1 --recursive https://github.com/MTKruto/server
cd server
```

And build using the following command:

```shell
deno task build
Expand Down
1 change: 1 addition & 0 deletions deno.jsonc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"exclude": ["./MTKruto/"],
"tasks": {
"test": "deno run -A tests/_run.ts",
"build": "deno compile -A --unstable-kv --include worker.ts --output mtkruto-server https://raw.githubusercontent.com/MTKruto/server/main/main.ts"
Expand Down

0 comments on commit 9c2140a

Please sign in to comment.