add external apps readme

This commit is contained in:
Youwen Wu 2024-02-24 19:07:56 -08:00
parent 53c0619080
commit cf8062c83c
2 changed files with 13 additions and 0 deletions

4
.gitignore vendored
View file

@ -2,3 +2,7 @@ node_modules
dist dist
.vscode .vscode
app/__pycache__/* app/__pycache__/*
# ignore external apps directory, except for the README
app/static/external-apps/*
!app/static/external-apps/README.md

View file

@ -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`