Skip to content
This repository was archived by the owner on Oct 28, 2025. It is now read-only.

Edit some minor grammatical errors in the Lichess flairs Readme.MD #20

Merged
merged 1 commit into from
Nov 28, 2023
Merged

Edit some minor grammatical errors in the Lichess flairs Readme.MD #20

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
16 changes: 8 additions & 8 deletions flair/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Lichess reads from this repository to get the list of available flairs.
If you want to add a flair, please submit a pull request.

The available flairs are visible on https://lichess1.org/assets/lifat/flair/index.html.
The available flairs are visible at https://lichess1.org/assets/lifat/flair/index.html.

Lichess flairs are not animated.

Expand All @@ -13,9 +13,9 @@ Lichess flairs are not animated.

This is probably a good source for new flairs: https://slackmojis.com/.

The lichess discord and zulip also have some good flairs.
The Lichess Discord and Zulip also have some good flairs.

Feel free to make your owns, or to get them from somewhere else - but be mindful of licenses.
Feel free to make your own, or to get them from somewhere else - but be mindful of licenses.

### Flair format

Expand All @@ -25,10 +25,10 @@ Lichess only uses webp flairs. You can convert your png to webp with `cwebp`:
cwebp path/to/horsey.png -o lifat/flair/img/activity.lichess-horsey.webp
```

Other similar programs are available, such as [ImageMagick](https://imagemagick.org/index.php).
Similar programs are available, such as [ImageMagick](https://imagemagick.org/index.php).

Now that you have a webp file, you can add it to the `flair/img` directory.
The name to the file is important, it's the only metadata we have. It's made of two parts: the category, and the name.
The name of the file is important, it's the only metadata we have. It's made of two parts: the category, and the name.

`<category>.<multi-word-name>.webp`

Expand All @@ -41,14 +41,14 @@ It can only contain letters, numbers, and dashes. Descriptive names help users f
### Compile the flair list

Optional. You can add and remove flair images without compiling the flair list,
and wait for someone else to compile it, before it comes online.
and wait for someone else to compile it before it comes online.

If you have a command line and want to compile the flair list, run:
If you have a command line and want to compile the flair list, run the following:

```shell
./flair/list.sh
```

It will update the `flair/list.txt` file which you must commit along with the update flair images.
It will update the `flair/list.txt` file which you must commit along with the updated flair images.

Lichess reads `flair/list.txt` periodically to update its flair database.