Browse Source

update docs

master
c? 2 years ago
parent
commit
08e582b3a6
4 changed files with 34 additions and 30 deletions
  1. 0
    1
      README.md
  2. 33
    0
      README.md
  3. 0
    29
      misc/README.md
  4. 1
    0
      misc/post-merge.example

+ 0
- 1
README.md View File

@@ -1 +0,0 @@
misc/README.md

+ 33
- 0
README.md View File

@@ -0,0 +1,33 @@
# Bang!

The DerpMail webapp frontend.

https://webmail.derpmail.pw/
https://manage.derpmail.pw/
https://lite.webmail.derpmail.pw/

Bang! loads DerpMail webapps inside a frame so that we can inject code
and make other special things happen with our webapps, without modifying
the webapps themselves too much.

Bang! also has some special UI features that allow it to be used as an
express DerpMail Mobile Lite app for Android by simply adding any Bang!
enabled webapp to the home screen within Chrome. Bang! also has
compatibility with DerpMail Mobile Plus (or DerpMail+) to allow some
special things to happen.

## Installation

```
mkdir /path/to/my/bang/webroot
cd /path/to/my/bang/webroot
git clone https://git.drg.li/DerpMail/bang.git
cd bang
cd misc
./fetch.sh
cp post-merge.example ../.git/hooks/post-merge
cd ..
ln -s bang/bang.html index.html
```
Install or symlink your webapp to `bangapp` in your webroot
Set the ErrorDocument 404 to /bang/404.html

+ 0
- 29
misc/README.md View File

@@ -1,29 +0,0 @@
# Bang!

The DerpMail webapp frontend.

https://webmail.derpmail.pw/

Bang! loads DerpMail webapps inside a frame so that we can inject code
and make other special things happen with our webapps, without modifying
the webapps themselves too much.

Bang! also has some special UI features that allow it to be used as an
express DerpMail Mobile Lite app for Android by simply adding any Bang!
enabled webapp to the home screen within Chrome. Bang! also has
compatibility with DerpMail Mobile Plus (or DerpMail+) to allow some
special things to happen.

## Installation

```
mkdir /path/to/my/bang/webroot
cd /path/to/my/bang/webroot
git clone https://git.drg.li/DerpMail/bang.git
cd bang
./fetch.sh
cd ..
ln -s bang/bang.html index.html
```
Install or symlink your webapp to `bangapp` in your webroot
Set the ErrorDocument 404 to /bang/404.html

+ 1
- 0
misc/post-merge.example View File

@@ -1,3 +1,4 @@
#!/bin/sh
# If you cloned this repo from git, you can copy this file to ../.git/hooks/post-merge to make the git commit version display at the bottom of the menu work.
# The Nginx SSI feature must be enabled for this to work.
git rev-parse --short HEAD > commit.html

Loading…
Cancel
Save