Skip to content

Commit

Permalink
readme edits
Browse files Browse the repository at this point in the history
  • Loading branch information
j34g committed Oct 26, 2024
1 parent c8ee95b commit 31f6027
Showing 1 changed file with 57 additions and 3 deletions.
60 changes: 57 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,65 @@ MySpeed is a speed test analysis software that records your internet speed for u
- 🗳️ Choose between Ookla, LibreSpeed and Cloudflare speed test servers
- 💁 Learn more about MySpeed on our [website](https://myspeed.dev)

### ⬇️ Installation
## Dependencies

- **🐧 Guide for [Linux](https://docs.myspeed.dev/setup/linux)**
- **🪟 Guide for [Windows](https://docs.myspeed.dev/setup/windows)**
Install the system dependencies below to build this project by following the instructions in the provided links. You can also find detailed steps to setup your environment in the service packaging [documentation](https://docs.start9.com/latest/developer-docs/packaging#development-environment).

- [docker](https://docs.docker.com/get-docker)
- [docker-buildx](https://docs.docker.com/buildx/working-with-buildx/)
- [yq](https://mikefarah.gitbook.io/yq)
- [deno](https://deno.land/)
- [make](https://www.gnu.org/software/make/)
- [start-sdk](https://github.com/Start9Labs/start-os/tree/sdk)

## Cloning

Clone the Webtop package repository locally.

```
git clone https://github.com/j34g/MySpeed-Start9.git
cd MySpeed-Start9
```

## Building

To build the service as a universal package, run the following command:

```
make
```

Alternatively the package can be built for individual architectures by specifying the architecture as follows:

```
make x86
```

or

```
make arm
```

## Installing (on StartOS)

Before installation, define `host: https://server-name.local` in your `~/.embassy/config.yaml` config file then run the following commands to determine successful install:

> Change server-name.local to your Start9 server address
```
start-cli auth login
#Enter your StartOS password
make install
```

**Tip:** You can also install the public-pool.s9pk by sideloading it under the **StartOS > System > Sideload a Service** section.

## Verify Install

Go to your StartOS Services page, select **MySpeed** and start the service.

**Done!**
### 📸 Example Screenshots

#### Homepage (List View)
Expand Down

0 comments on commit 31f6027

Please sign in to comment.