Skip to content

Commit

Permalink
Update starlight, make installation instructions clearer
Browse files Browse the repository at this point in the history
  • Loading branch information
NotNite committed Jan 9, 2025
1 parent c7665ea commit 4b44365
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 54 deletions.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/starlight": "^0.30.3",
"astro": "^5.1.2",
"@astrojs/starlight": "^0.30.5",
"astro": "^5.1.4",
"sharp": "^0.32.5",
"starlight-blog": "^0.16.1",
"starlight-links-validator": "^0.14.1",
Expand Down
73 changes: 29 additions & 44 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 10 additions & 7 deletions src/content/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,20 @@ hero:
light: ../../img/wordmark.png
alt: moonlight
actions:
- text: Docs
- text: Install
link: /using/install
icon: right-arrow
icon: download
- text: Docs
link: /ext-dev/getting-started
icon: open-book
- text: Discord server
link: https://discord.gg/FdZBTFCP6F
variant: minimal
icon: external
variant: secondary
icon: discord
- text: GitHub
link: https://github.com/moonlight-mod/moonlight
variant: minimal
icon: external
variant: secondary
icon: github
---

<img class="light:sl-hidden" src="/moonbase.png" alt="A screenshot of Moonbase, the moonlight UI" />
Expand All @@ -29,6 +32,6 @@ hero:

moonlight is heavily inspired by hh3 (a private client mod) and the projects before it that it is inspired by, namely EndPwn. All core code is original or used with permission from their respective authors where not copyleft.

**_This is an experimental passion project._** Anything and everything is subject to change, but it is stable enough for developers to experiment with.
**_This is an experimental passion project._** Anything and everything is subject to change, but it is stable enough for tinkerers and developers to experiment with.

moonlight is licensed under the [GNU Lesser General Public License](https://www.gnu.org/licenses/lgpl-3.0.html) (`LGPL-3.0-or-later`).
5 changes: 4 additions & 1 deletion src/content/docs/using/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ description: How to install, build, and use moonlight
sidebar:
order: 1
---
import { FileTree } from "@astrojs/starlight/components";
import { FileTree, LinkButton } from "@astrojs/starlight/components";

There are several ways to install moonlight: through the GUI installer, the CLI installer, or manually building it yourself. If you do not plan to develop on the moonlight codebase itself, it is suggested to use the GUI installer.

## moonlight installer

<LinkButton href="https://github.com/moonlight-mod/moonlight-installer/releases/latest/download/moonlight-installer.exe" icon="seti:windows">Download</LinkButton>
<LinkButton href="https://github.com/moonlight-mod/moonlight-installer/releases/latest/download/moonlight-installer-macos.dmg" icon="apple">Download</LinkButton>

The moonlight [installer](https://github.com/moonlight-mod/moonlight-installer) automates the installation process for you. **This is the suggested way to install moonlight for Windows and macOS users.**

To use it, [download](https://github.com/moonlight-mod/moonlight-installer/releases/latest) and run the installer, download moonlight through it, and then patch a Discord installation. Discord installations are autodetected on your machine. Keep the installer in the event that a Discord update breaks moonlight, so you can unpatch Discord or update moonlight.
Expand Down

0 comments on commit 4b44365

Please sign in to comment.