30 lines
805 B
Markdown
30 lines
805 B
Markdown
# xrsh
|
|
|
|
<img src='src/assets/logo.svg' width="25%"/>
|
|
|
|
## Wiki / Roadmap
|
|
|
|
See [the wiki here](https://forgejo.isvery.ninja/xrsh/xrsh/wiki/Home#milestones)
|
|
|
|
## Install
|
|
|
|
|
|
> NOTE: installation not needed, just surf to the public version [here](https://coderofsalvation.github.io/xrsh)
|
|
|
|
1. Download [xrsh.com](https://forgejo.isvery.ninja/xrsh/xrsh/raw/branch/main/xrsh.com)
|
|
2. optional: run `unzip xrsh.com` to verify repository contents
|
|
3. run `chmod +x xrsh.com` in your console
|
|
3. run `./xrsh.com`
|
|
4. Profit! ✔
|
|
|
|
## Developers
|
|
|
|
Make sure to clone the repo including submodules (the [xrsh-com](https://forgejo.isvery.ninja/xrsh/xrsh-com) repo)
|
|
|
|
```
|
|
$ git clone --recurse-submodules https://forgejo.isvery.ninja/xrsh/xrsh
|
|
```
|
|
|
|
> Now serve the repo from a HTTPS webserver (for example run `./make dev`)
|
|
|
|
|