aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL.md
blob: b9e9cd350d5c2d389df0c6caf80d75145a76bd11 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# Mac OS X

## Dependencies

### Python 3

Learn more: https://docs.python.org/3

Install with [homebrew](http://brew.sh),

    sudo xcodebuild -license ;
    ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" ;
    brew install python3 ;

### PyQt5

Learn more: https://www.riverbankcomputing.com/software/pyqt

Install with homebrew,

    brew install pyqt5 ;

### Python dependencies

    sudo pip install -r requirements.txt

## Trufont

Homepage: https://trufont.github.io

To install and run,

    cd .. ;
    git clone --depth=1 https://github.com/trufont/trufont ;
    cd trufont ;
    sudo python3 setup.py install --record installed-files.txt ;
    python3 -m defconQt ;

Or to then run from source,

    cd Lib/ ; 
    python3 -m defconQt ;

To build installation packages,

    cd Lib/ ;
    sh build.sh ;

Distribution packages will be placed in in `Lib/dist/`.
To build an installation package for Mac OS X 10.9, you must build the package on that version of the OS.

## Uninstall

Files are installed into `/usr/local/lib/python3.5/site-packages/` 

    sudo easy_install pip ;
    sudo pip uninstall -r requirements.txt

If you installed TruFont with `setup.py`, it can be uninstalled with this command
(be careful with rm!):

    cat installed-files.txt | xargs sudo rm --verbose -vr

# Debian, Ubuntu

(Note that we are using Python 3.4)

## Dependencies

    sudo apt-get install -qq -y python3-pyqt5 python3-pyqt5.qtsvg python3-flake8 ;
    sudo pip3 install -r requirements.txt

## Trufont

To install and run,

    cd .. ;
    git clone --depth=1 https://github.com/trufont/trufont ;
    cd trufront ;
    sudo python3 setup.py install --record installed-files.txt ;
    python3 -m defconQt ;

Or to then run from source,

    cd Lib/ ; 
    python3 -m defconQt ;

## Uninstall

Files are installed into `/usr/local/lib/python3.4/dist-packages/`

These can be removed with pip:

    sudo apt-get install python3-pip ;
    sudo pip3 uninstall -r requirements.txt

If you installed TruFont with `setup.py`, it can be uninstalled with this command
(be careful with rm!):

    cat installed-files.txt | xargs sudo rm --verbose -vr

# Virtualenv

[Virtualenv](https://virtualenv.pypa.io) is optional. If you plan to use it and you've installed
PyQt5 with Homebrew or Apt, then add the `--system-site-packages` flag when creating the Virtualenv
to make PyQt5 available:

    virtualenv --system-site-packages virutalenv-name