Commit 426c93fc authored by bzt's avatar bzt

Docs

parent f47b6030
Scalable Screen Font Editor
===========================
Command Line
------------
Very simple, there is only one aregument, the name of the font file you want to edit.
```sh
$ ./sfnedit
Scalable Screen Font Editor by bzt Copyright (C) 2019 MIT license
./sfnedit <.sfn|.asc|.sfn.gz|.asc.gz>
```
That font can be in [SSFN](https://gitlab.com/bztsrc/scalable-font/blob/master/docs/sfn_format.md) or
in [ASC](https://gitlab.com/bztsrc/scalable-font/blob/master/docs/asc_format.md) format, and if the
editor was compiled with libz support, then it can be gzip compressed.
The editor is multilingual, and autodetects the language from the environment. If you want to use
a different language than your OS' default, you can specify it in the LANG environment variable:
```sh
$ LANG=hu ./sfnedit
```
All windows are splited vertically into a tab navigation bar (on the top), and a
tab area (the rest, bigger part of the window). By clicking on the tab label in the
navigation bar, you can switch the tab area.
......@@ -9,6 +30,7 @@ These keyboard shortcuts work in all windows.
| Key Combination | Description |
| --------------- | ----------- |
| <kbd>F1</kbd> | Context dependent built-in help |
| <kbd>Esc</kbd> | Close the window |
| <kbd>Ctrl</kbd>+<kbd>s</kbd> | Save the font in SSFN format |
| <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>s</kbd> | Save the font in ASC format |
......@@ -94,12 +116,12 @@ when you opened the window.
<img src='https://gitlab.com/bztsrc/scalable-font/raw/master/docs/sfnedit5.png'>
This is the main editing tab. On the left, there're icons, and on the right, which
occupies the rest of the window, is the edit area.
This is the main editing tab. On the left, there's the toolbar, and on the right (which
occupies the rest of the window) is the edit area.
### Toolbar
You can select an icon from the toolbar by clicking, they are in order:
You can select an icon from the toolbar by clicking, the icons are in order:
- Change horizontal advance
- Change vertical advance
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment