Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jenskutilek committed Oct 11, 2022
1 parent a0d60a4 commit a212416
Showing 1 changed file with 23 additions and 6 deletions.
29 changes: 23 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,44 @@
# WoLiBaFoNaGen

Word List Based Font Name Generator

![](https://github.com/jenskutilek/WoLiBaFoNaGen/blob/master/images/screenshot-mac.png)

The generator uses the wxPython UI library. So if you don’t have it installed already, you need to install it before you can run WoLiBaFoNaGen:
## Development

Install the dependencies before you can run or build WoLiBaFoNaGen, preferably
in a virtual environment:

```bash
$ pip --user install wx
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -r requirements-dev.txt
```

Run:

```bash
$ python WoLiBaFoNaGen.py
$ python3 WoLiBaFoNaGen.py
```

Build the Mac app:
Build and debug as a Mac app:

```bash
$ pip install --user --ignore-installed py2app
$ python setup.py py2app
$ make debug
```

Build the Mac app for distribution:

```bash
$ make dist
```

## Outdated information

### Windows

Those instructions have not been updated for Python 3 yet.

Build the Windows app:

```bash
Expand Down

0 comments on commit a212416

Please sign in to comment.