docs/README-ChromeOS.rst

Sun, 25 Jul 2021 16:54:08 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 25 Jul 2021 16:54:08 +0200
branch
eric7
changeset 8477
81e25fe19818
child 8570
65ec02bfa9d2
permissions
-rw-r--r--

Updated the documentation contained in the 'docs' folder.

8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 =========================
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 Readme for ChromeOS usage
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 =========================
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 This Readme describes the steps to be performed to use eric on a
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 Chromebook with ChromeOS.
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 1. Preparation
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 --------------
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 Step 1: activate the Linux environment through the settings
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 Step 2: open a terminal window and execute these steps
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 ::
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 sudo apt update
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 sudo apt upgrade
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18 sudo apt install libopengl0 python3-pip python3-venv
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 Step 3: modify environment to make Qt not use Wayland
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 As of ChromeOS 91 Qt6 is not yet compatible with the ChromeOS Wayland
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 implementation. In order to force Qt applications to use X11 modify
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 the "cros-garcon-override.conf" file.
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 ::
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 sudo vi /etc/systemd/user/cros-garcon.service.d/cros-garcon-override.conf
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 and add the line
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 ::
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 Environment="QT_QPA_PLATFORM=xcb"
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 2. eric Installation
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 --------------------
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 Installing eric7 is a simple process. There are various methods available.
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 Please choose the one best suited to your needs and skills. eric7 may be must
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 with Python 3, Qt5 and PyQt5.
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 2.1 Create a Python virtual environment for eric7
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 It is recommended to install eric7 into a Python virtual environment in order
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 to keep your Python distribution clean. In order to do that create it by
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 entering the following command in the terminal window.
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 ::
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 python3 -m venv eric7_venv
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 Replace ``eric7_venv`` with the desired path to the directory for the virtual
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 environment. All further instructions will assume this environment name.
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 2.2 Variant 2: Installation via the Python Package Index PyPI
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 Enter the following command in the terminal window.
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 ::
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 ~/eric7_venv/bin/python3 -m pip install --upgrade eric-ide
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 Once the installation is finished navigate to the executable directory of
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 the Python virtual environment and execute the ``eric7_post_install`` script.
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 ::
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 ~/eric7_venv/bin/eric7_post_install
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 2.3 Installation of Qt Tools via Qt online installer
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 In order to get the most out of eric7 it is recommended to install the Qt Tools
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 like ``Qt Designer`` or ``Qt Linguist``. The recommended way is this.
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 1. Download the Qt online installer from the Qt download site.
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 2. Install Qt by executing the installer.
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 3. Configure the path to the Qt tools on the ``Qt`` configuration page of the
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 eric7 configuration dialog.
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 3.0 Install optional packages for eric7 (for plug-ins)
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 eric7 provides an extension mechanism via plug-ins. The plug-ins are
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 available via the Plugin Repository dialog from within eric7. Some plugins
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 require the installation of additional python packages. This is done
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 automatically during the plugin installation.

eric ide

mercurial