Update README for clarity and add logo.

This commit is contained in:
Ryan Volz 2024-05-01 15:58:04 -04:00
parent a71156de69
commit 33b03ddbcb
2 changed files with 4 additions and 4 deletions

View File

@ -1,6 +1,4 @@
# radioconda
![Build radioconda](https://github.com/ryanvolz/radioconda/actions/workflows/build_radioconda.yml/badge.svg)
# ![radioconda](static/radioconda_logo.png)
This repository holds cross-platform installers for a collection of open source **software radio** packages bundled with the [conda](https://conda.io/) package manager, including
@ -89,7 +87,7 @@ You will mostly use radioconda through the command line, although on Windows som
### Windows
Launch a terminal by running "Conda Prompt" in the "radioconda" directory in the Start menu. From this command line, you can run `mamba` to install/upgrade packages or run any of the applications installed with radioconda. Some applications can also be launched through shortcuts added to the Start menu.
Launch "Conda Prompt" from the Start menu (you can find it under the "radioconda" directory). From this command line, you can run `mamba` to install/upgrade packages or run any of the applications installed with radioconda. Some applications can also be launched through shortcuts added to the Start menu.
### Linux and macOS
@ -324,6 +322,8 @@ Many USB devices use libusb and need a WinUSB driver installed on Windows. Follo
## Developers
![Build radioconda](https://github.com/ryanvolz/radioconda/actions/workflows/build_radioconda.yml/badge.svg)
### Usage
Each installer package is built from a specification directory in [installer_specs](https://github.com/ryanvolz/radioconda/tree/master/installer_specs) using [conda constructor](https://github.com/conda/constructor). An installer can be built manually using the [build_installer.py](https://github.com/ryanvolz/radioconda/blob/master/build_installer.py) script. The specification directories set the exact versions of the included packages so that `constructor` will produce a predictable result that can be tracked by git for each release. In turn, the specification directories are created/updated by _re-rendering_ the radioconda [environment specification file](https://github.com/ryanvolz/radioconda/blob/master/radioconda.yaml) using the [rerender.py](https://github.com/ryanvolz/radioconda/blob/master/rerender.py) script.

BIN
static/radioconda_logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 550 KiB