Skip to content

Commit 6b204fd

Browse files
Simplify documentation
1 parent e54288a commit 6b204fd

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,28 @@
33
[![build-test](https://github.com/kishaningithub/setup-python-amazon-linux/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/kishaningithub/setup-python-amazon-linux/actions/workflows/test.yml)
44

55
Github action to install python in amazon linux. The goal of this action is to be a drop in replacement
6-
for the github's official [setup-python action](https://github.com/actions/setup-python) to the maximum extent possible.
6+
for the Github's official [setup-python action](https://github.com/actions/setup-python) to the maximum extent possible.
77

88
## Why?
99

10-
- This project exist because as of Nov 2023 [Github has no plans support amazon linux](https://github.com/actions/setup-python/issues/460#issuecomment-1185723652) for its official
10+
- This project exists because, as of Nov 2023 [Github has no plans support amazon linux in the foreseeable future](https://github.com/actions/setup-python/issues/460#issuecomment-1185723652) for its official
1111
[setup-python](https://github.com/actions/setup-python) action for amazon linux self-hosted runners.
1212

13+
## Usage
14+
15+
All you have to do is change "setup-python" to "setup-python-amazon-linux" in your workflows
16+
17+
```yaml
18+
steps:
19+
- uses: actions/checkout@v3
20+
- uses: actions/setup-python-amazon-linux@v1
21+
with:
22+
python-version: '3.10'
23+
- run: python my_script.py
24+
```
25+
26+
For more options to the action, kindly refer [action.yml](./action.yml)
27+
1328
## Implementation caveat
1429
1530
This action compiles the desired version of python from source for the first time because the glibc version in use in
@@ -20,7 +35,7 @@ python: /lib64/libc.so.6: version `GLIBC_2.27' not found
2035
python: /lib64/libc.so.6: version `GLIBC_2.28' not found
2136
```
2237
23-
Hence only for the first time this action may like 3 to 4 minutes depending on the runner configuration. Post this only cache
38+
Hence, only for the first time this action may like 3 to 4 minutes depending on the runner configuration. Post this only cache
2439
will be used and hence will be very fast (4 to 5 seconds)
2540
2641
## Supported amazon linux flavours
@@ -30,21 +45,6 @@ will be used and hence will be very fast (4 to 5 seconds)
3045
3146
If you need support for more kindly raise an issue or a PR
3247
33-
## Usage
34-
35-
All you have to do is change "setup-python" to "setup-python-amazon-linux" in your workflows
36-
37-
```yaml
38-
steps:
39-
- uses: actions/checkout@v3
40-
- uses: actions/setup-python-amazon-linux@v1
41-
with:
42-
python-version: '3.10'
43-
- run: python my_script.py
44-
```
45-
46-
For more options to the action, kindly refer [action.yml](./action.yml)
47-
4848
## Contributing
4949
5050
Contributions are most welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md)

0 commit comments

Comments
 (0)