From 5163ed648add2e03c463805774d65145800fc596 Mon Sep 17 00:00:00 2001 From: BarsTiger Date: Tue, 8 Feb 2022 22:31:14 +0200 Subject: [PATCH] Development app docs --- README.md | 2 +- docs/developers/developing-app.md | 41 +++++++++++++++++++++++++++++++ docs/developers/file-req.md | 10 ++++++++ docs/users/updating.md | 14 +++++++++++ 4 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 docs/developers/file-req.md diff --git a/README.md b/README.md index aaba2fa..d3a1b99 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Website +# horsy docs This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. diff --git a/docs/developers/developing-app.md b/docs/developers/developing-app.md index e69de29..0de42a4 100644 --- a/docs/developers/developing-app.md +++ b/docs/developers/developing-app.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 1 +--- + +# Developing app + +So, you are a developer and you want to publish your app on horsy. + +At first, you need to know, how horsy works. + +For example, kotogamescam launch script looks like this: + +```bash +%horsypath:~0,1%: +cd %horsypath%/apps/kotogamescam +KotoGameScam.exe %* +``` + +In simple words, it runs KotoGameScam.exe with all arguments. + +First line navigates to disk, where KotoGameScam.exe is located. + +Second line is a changing dir to KotoGameScam dir. + +And third line is a command to run KotoGameScam.exe with all arguments. + +`%*` means that all arguments applied to launch script will be passed to KotoGameScam.exe, so all CLI tools will work. + +:::danger CD to app folder +Script changes dir to app folder. +Maybe, your app created to run from another folder, added to path and user can run it from anywhere, but it will not work here. +So, while developing, you should remember that horsy will run your app from %horsypath%/apps/app folder with CD to app folder +::: + +We don't moderate apps and we don't have any rules for developing, but we need to say, that best way to make your app popular - adding sources to horsy. +We'll **[verify](/docs/more/verification)** only open-source apps. + +Please, dont upload apps, that contain malware or other harmful code. +We don't delete apps like this, but you should be aware that we can delete your app if we think it's not safe for our servers or it contains malware, that can harm user, that doesn't know about it. + +So, we don't moderate apps, but for some reasons we can delete your app without describing why, you should remember this and create only *good* apps. diff --git a/docs/developers/file-req.md b/docs/developers/file-req.md new file mode 100644 index 0000000..956bbe0 --- /dev/null +++ b/docs/developers/file-req.md @@ -0,0 +1,10 @@ +--- +sidebar_position: 2 +--- + +# Requirements +To upload your app, you need to: +- Have an account +- Have file, that can be launched from command line +- Know, how to launch your app from any PC +- Know which files are required to run your app and how to install them diff --git a/docs/users/updating.md b/docs/users/updating.md index 16e7751..0ae76d1 100644 --- a/docs/users/updating.md +++ b/docs/users/updating.md @@ -4,4 +4,18 @@ sidebar_position: 7 # Updating app +# CLI, TUI +You can just update the app by re-running install command: +``` +horsy install +``` +# GUI +Select app in `Installed` tab + +Select needed app + +Click `Update` button + +## What happens +horsy will download newest version of app and replace old one