Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Formating and improve the tables to README.md #11

Merged
merged 1 commit into from
Nov 18, 2016
Merged

Formating and improve the tables to README.md #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ _Relatively_ up-to-date documentation can be found [at my site here](http://lemm

## Usage
The generator itself is in `sig.php`. All templates accepts the following parameters:

* `uname` - **required** The username of the user you want to generate a signature for
* `colour` - The background and stroke colour of the signature. Valid values are any 6 digit hex value prepended by `hex` or `%23`, or:

Expand Down Expand Up @@ -43,23 +42,20 @@ TemplateNormal accepts the following:
| `colour` | `uname` | `mode` | Image |
| -------- | -------- | ----------- |:-----:|
| `green` | `Lemmmy` | unspecified | ![](http://lemmmy.pw/osusig/sig.php?colour=green&uname=Lemmmy) |
| `pink` | `peppy` | `1` | ![](http://lemmmy.pw/osusig/sig.php?colour=pink&uname=peppy&mode=1) |
| `pink` | `sobatsuyu` | `1` | ![](http://lemmmy.pw/osusig/sig.php?colour=pink&uname=sobatsuyu&mode=1) |
| `hexFFAA00`| `hvick225` | `0` | ![](http://lemmmy.pw/osusig/sig.php?colour=hexFFAA00&uname=hvick225&mode=0) |

_Note:_ `hex` is a workaround for osu!'s gocamo server

### Live examples

`http://lemmmy.pw/osusig/sig.php?colour=purple&uname=Lemmmy`
![](http://lemmmy.pw/osusig/sig.php?colour=purple&uname=Lemmmy)


`http://lemmmy.pw/osusig/sig.php?colour=blue&uname=rrtyui&pp=2`
![](http://lemmmy.pw/osusig/sig.php?colour=blue&uname=rrtyui&pp=2)
| URL | `Image` |
| -------- | :--------: |
| `http://lemmmy.pw/osusig/sig.php?colour=purple&uname=Lemmmy` | ![](http://lemmmy.pw/osusig/sig.php?colour=purple&uname=Lemmmy) |
| `http://lemmmy.pw/osusig/sig.php?colour=blue&uname=rrtyui&pp=2` | ![](http://lemmmy.pw/osusig/sig.php?colour=blue&uname=rrtyui&pp=2)|
| `http://lemmmy.pw/osusig/sig.php?colour=yellow&uname=jhlee0133&mode=3&pp=1` |![](http://lemmmy.pw/osusig/sig.php?colour=yellow&uname=jhlee0133&mode=3&pp=1) |


`http://lemmmy.pw/osusig/sig.php?colour=yellow&uname=jhlee0133&mode=3&pp=1`
![](http://lemmmy.pw/osusig/sig.php?colour=yellow&uname=jhlee0133&mode=3&pp=1)

## Requirements
The generator requires ImageMagick and memcached.
Expand Down Expand Up @@ -96,4 +92,4 @@ img/taiko.png
img/osu.png
```

The flags in `flags/*` are created by Muharrem Şenyıl and can be found on his [Dribbble](https://dribbble.com/shots/1211759-Free-195-Flat-Flags).
The flags in `flags/*` are created by Muharrem Şenyıl and can be found on his [Dribbble](https://dribbble.com/shots/1211759-Free-195-Flat-Flags).