Skip to content

Commit

Permalink
Add section about Supported Platforms in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nroi committed Oct 17, 2024
1 parent c44a7c9 commit cc3b89d
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ to be downloaded more often than once.
echo 'Server = http://172.17.0.1:7878/$repo/os/$arch' > /etc/pacman.d/mirrorlist
````
so that packages that have already been downloaded will be fetched from the cache.
## Installation
A package for Arch Linux is available on [AUR](https://aur.archlinux.org/packages/flexo-git/).
Alternatively, you can use the [docker image](https://hub.docker.com/r/nroi/flexo) instead.
Expand Down Expand Up @@ -90,6 +91,18 @@ With `ParallelDownloads` enabled, Flexo will receive multiple requests concurren
fetch the packages from multiple mirrors in parallel, thus making it more likely that your entire bandwidth
is utilized.
## Supported Platforms
Flexo obviously runs on a standard Arch Linux x86_64 platform. In addition, it runs on many ARM
platforms (more details [here](#arm-support)).
If you intend to compile and run Flexo on any operating system other than ArchLinux (and without
Flexo's Docker image), please note that:
* Flexo requires either [paccache](https://man.archlinux.org/man/paccache.8) or
[scruffy](https://github.com/nroi/scruffy) to clean the cache. On any system other than ArchLinux,
installing scruffy will probably be easier than installing paccache.
* Linux is the only supported operating system at the moment.
## Troubleshooting
If Flexo does not start at all or crashes, check the logs first:
Expand Down

0 comments on commit cc3b89d

Please sign in to comment.