Skip to content

Commit c3fb4d2

Browse files
codingfrog27yuri91
authored andcommitted
installation extra docs + PR notes and prettier implemented
1 parent fcaa8ff commit c3fb4d2

File tree

1 file changed

+38
-6
lines changed

1 file changed

+38
-6
lines changed

sites/cheerp/src/content/docs/10-getting-started/01-installation.md

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,52 @@ The first step to using Cheerp is to install the Cheerp toolchain.
88
> [!info] Command Line Notation
99
> Throughout this documentation, we’ll show some commands used in the terminal. Lines that you should enter in a terminal all start with `$`. You don’t need to type the `$` character; it’s the command line prompt shown to indicate the start of each command. Lines that don’t start with `$` typically show the output of the previous command.
1010
11-
### Installing Cheerp on Linux
11+
## Installing Cheerp on Linux
1212

1313
[![Packaging status](https://repology.org/badge/vertical-allrepos/cheerp.svg)](https://repology.org/project/cheerp/versions)
1414

1515
#### Ubuntu
1616

17-
Use our [PPA](https://launchpad.net/~leaningtech-dev/+archive/ubuntu/cheerp-ppa):
17+
> [!info] Releases
18+
> we offer both stable and nightly builds,
19+
> but since our stable build is at this time a few years old, we recommend using nightly
20+
21+
Use our nightly build [PPA](https://launchpad.net/~leaningtech-dev/+archive/ubuntu/cheerp-nightly-ppa)
22+
23+
(or alternatively our stable build [PPA](<(https://launchpad.net/~leaningtech-dev/+archive/ubuntu/cheerp-ppa):>))
1824

1925
```sh
20-
$ sudo add-apt-repository ppa:leaningtech-dev/cheerp-ppa
26+
$ sudo add-apt-repository ppa:leaningtech-dev/cheerp-nightly-ppa
2127
$ sudo apt-get update
2228
$ sudo apt-get install cheerp-core
2329
```
2430

31+
> [!warning] being ahead of our supported LTS builds
32+
> if you encounter a "the repo does not have a Release file" error
33+
> your Ubuntu release is most likely newer than our latest build. In this case you will need to manually edit the .sources file following the steps below.
34+
35+
1. open the .sources file for the PPA release, which is located at:
36+
37+
```
38+
/etc/apt/sources.list.d/leaningtech-dev-ubuntu-cheerp-nightly-ppa-<codename>.sources
39+
```
40+
41+
With `<codename>` being replaced by the codename of your release
42+
43+
(You can find your current codename using `lsb_release -cs`)
44+
45+
2. Check which releases we have a build for [here](https://ppa.launchpadcontent.net/leaningtech-dev/cheerp-nightly-ppa/ubuntu/dists/) and change the `Suites:` line to specify our latest LTS release instead of your codename.
46+
47+
(Even if our latest build is an LTS release behind there should be no issues, since cheerp uses minimal dependencies)
48+
49+
3. ```sh
50+
$ sudo apt-get update
51+
$ sudo apt-get install cheerp-core
52+
```
53+
54+
<br>
55+
<br>
56+
2557
#### Arch
2658

2759
Use our [AUR package](https://aur.archlinux.org/packages/cheerp-git):
@@ -39,15 +71,15 @@ $ yay -S cheerp-git
3971

4072
Users on other Linux distributions must [build Cheerp from source](/docs/building-from-source/linux).
4173

42-
### Installing Cheerp on Windows
74+
## Installing Cheerp on Windows
4375

4476
Download the latest graphical installer from [GitHub](https://github.com/leaningtech/cheerp-meta/releases) and follow the installation wizard. The default installation path is currently the only supported one.
4577

4678
You can also [build Cheerp from source](/docs/building-from-source/windows) if you prefer.
4779

4880
If you are using WSL, follow the [instructions for Linux](#installing-cheerp-on-linux).
4981

50-
### Installing Cheerp on macOS
82+
## Installing Cheerp on macOS
5183

5284
<!-- TODO: brew -->
5385

@@ -59,7 +91,7 @@ The binary is not signed so you may need to run the following to stop Gatekeeper
5991
$ sudo xattr -d com.apple.quarantine /Applications/cheerp/bin/*
6092
```
6193

62-
## Troubleshooting
94+
## Testing
6395

6496
To check whether you have installed Cheerp correctly, you can run the following command:
6597

0 commit comments

Comments
 (0)