Skip to content

Commit b0d74c5

Browse files
committed
Add the instruction using package managers to README.md
1 parent 7eb2bea commit b0d74c5

1 file changed

Lines changed: 35 additions & 15 deletions

File tree

README.md

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# LPython
22

33
LPython is an ahead-of-time compiler for Python written in C++. It is currently in alpha
4-
stage and under heavy development. LPython works on Windows, macOS and Linux.
4+
stage and under heavy development. LPython works on Windows, macOS and Linux.
55

66
Some of the goals of LPython include:
77

@@ -26,15 +26,36 @@ LFortran, see that project for a list of sponsors.
2626

2727
Follow the steps below to install and run LPython on Linux, Windows or macOS.
2828

29-
## Prerequisites
30-
- ### Install Conda
29+
## Using package managers
30+
31+
You can install lpython using conda-package managers.
32+
33+
```shell
34+
# conda
35+
conda install -c conda-forge lpython
36+
37+
# mamba
38+
mamba install -c conda-forge lpython
39+
40+
# micromamba
41+
micromamba install -c conda-forge lpython
42+
43+
# pixi (global installation across all environments)
44+
pixi global install lpython
45+
46+
```
47+
48+
## Building from source
49+
50+
### Prerequisites
51+
- #### Install Conda
3152
Follow the instructions provided [here](https://github.com/conda-forge/miniforge/#download) to install Conda on your platform (Linux, macOS and Windows) using a conda-forge distribution called Miniforge.
32-
53+
3354
For Windows, these are additional requirements:
3455
- Miniforge Prompt
3556
- Visual Studio (with "Desktop Development with C++" workload)
3657

37-
- ### Set up your system
58+
- #### Set up your system
3859
- Linux
3960
- Run the following command to install some global build dependencies:
4061

@@ -73,22 +94,22 @@ Follow the steps below to install and run LPython on Linux, Windows or macOS.
7394
```bash
7495
conda create -n lp -c conda-forge llvmdev=11.0.1 bison=3.4 re2c python cmake make toml clangdev git
7596
```
76-
97+
7798
- Optionally, you can change the directory to a Windows location using `cd /mnt/[drive letter]/[windows location]`. For e.g. - `cd mnt/c/Users/name/source/repos/`.
7899

79-
80-
- ### Clone the LPython repository
100+
101+
- #### Clone the LPython repository
81102
Make sure you have `git` installed. Type the following command to clone the repository:
82103

83104
```bash
84105
git clone https://github.com/lcompilers/lpython.git
85106
cd lpython
86107
```
87-
108+
88109
You may also use GitHub Desktop to do the same.
89110

90-
## Building LPython
91-
- ### Linux and macOS
111+
### Building LPython
112+
- #### Linux and macOS
92113
- Create a Conda environment:
93114

94115
```bash
@@ -107,7 +128,7 @@ Follow the steps below to install and run LPython on Linux, Windows or macOS.
107128
./build1.sh
108129
```
109130

110-
- ### Windows
131+
- #### Windows
111132
- Create a Conda environment using the pre-existing file:
112133

113134
```bash
@@ -121,7 +142,7 @@ Follow the steps below to install and run LPython on Linux, Windows or macOS.
121142
call build0.bat
122143
call build1.bat
123144
```
124-
- ### Windows with WSL
145+
- #### Windows with WSL
125146

126147
- Activate the Conda environment:
127148
```bash
@@ -149,13 +170,12 @@ Do not forget to clean your history, see [example](./doc/src/rebasing.md).
149170
See the [CONTRIBUTING](CONTRIBUTING.md) document for more information.
150171

151172
## Found a bug?
152-
Please report any bugs you find at our issue tracker [here](https://github.com/lcompilers/lpython/issues). Or, even better, fork the repository on GitHub and create a Pull Request (PR).
173+
Please report any bugs you find at our issue tracker [here](https://github.com/lcompilers/lpython/issues). Or, even better, fork the repository on GitHub and create a Pull Request (PR).
153174

154175
We welcome all changes, big or small. We will help you make a PR if you are new to git.
155176

156177
If you have any questions or need help, please ask us at [Zulip](https://lfortran.zulipchat.com/) or on our [mailinglist](https://groups.io/g/lfortran).
157178

158-
159179
# Star History
160180

161181
[![Star History Chart](https://api.star-history.com/svg?repos=lcompilers/lpython&type=Date)](https://star-history.com/#lcompilers/lpython&Date)

0 commit comments

Comments
 (0)