From cf8062c83c3c1832d1922f696eb81f064c52890b Mon Sep 17 00:00:00 2001 From: Youwen Wu Date: Sat, 24 Feb 2024 19:07:56 -0800 Subject: [PATCH] add external apps readme --- .gitignore | 4 ++++ app/static/external-apps/README.md | 9 +++++++++ 2 files changed, 13 insertions(+) create mode 100644 app/static/external-apps/README.md diff --git a/.gitignore b/.gitignore index 864e857..173f39f 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,7 @@ node_modules dist .vscode app/__pycache__/* + +# ignore external apps directory, except for the README +app/static/external-apps/* +!app/static/external-apps/README.md \ No newline at end of file diff --git a/app/static/external-apps/README.md b/app/static/external-apps/README.md new file mode 100644 index 0000000..3c69ac0 --- /dev/null +++ b/app/static/external-apps/README.md @@ -0,0 +1,9 @@ +# External apps + +In this directory, external apps that can be added to jankboard can be added. Jankboard supports any static project that exposes a root index.html +which can be used in an i-frame. The files in this folder have been gitignored because of their massive size. If you would like to enable external apps, then clone them from the list below and then add them to this directory as specified. + +## App List + +- GBA Emulator + - Set the folder name to: `gba-emulator`