Skip to content

Commit 8aa2643

Browse files
committed
Improve instructions in the README and add pretty badges.
1 parent bc11af0 commit 8aa2643

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Cubase Project
22

3+
[![Build Status](https://github.com/fgimian/cubase-project-plugins/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/fgimian/cubase-project-plugins/actions)
4+
[![License](https://img.shields.io/github/license/fgimian/cubase-project-plugins)](https://github.com/fgimian/cubase-project-plugins/blob/main/LICENSE)
5+
[![Latest Release](https://img.shields.io/github/v/release/fgimian/cubase-project-plugins?include_prereleases)](https://github.com/fgimian/cubase-project-plugins/releases)
6+
37
This program will analyse a directory containing Cubase projects recursively and show the version
48
of Cubase the project was created with along with a list all the plugins used (with their GUIDs).
59

@@ -9,7 +13,19 @@ The tool works for projects created in Cubase 4 or later. Older projects (e.g.
913
SX3) will only show the Cubase version but no plugins will be listed and architecture may be
1014
assumed to be 32-bit.
1115

12-
## Configuring the Tool
16+
## Getting Started
17+
18+
### Downloading the Installer
19+
20+
You may download the latest release from the
21+
[releases page](https://github.com/fgimian/cubase-project-plugins/releases). Simply expand the
22+
executable contained in the chosen archive to a directory in your environment path.
23+
24+
### Usage
25+
26+
You may now run the tool using the `cubase-project-plugins` executable. Please use the `-h/--help` option for further usage instructions.
27+
28+
### Configuration
1329

1430
You may optionally create a TOML config file for the utility which includes certain paths and
1531
plugins to exclude from output. The default location where the tool will search for the config
@@ -45,21 +61,6 @@ name_ignores = [
4561

4662
You may see the sample config **config.sample.toml** for inspiration.
4763

48-
## Running the Tool
49-
50-
### Usage
51-
52-
1. Install [Rust](https://www.rust-lang.org/tools/install)
53-
2. Install the tool
54-
55-
```
56-
cargo install --git https://github.com/fgimian/cubase-project-plugins.git
57-
```
58-
59-
3. You may now run the tool using the `cubase-project-plugins` executable
60-
61-
Please use the `-h/--help` option for further usage instructions.
62-
6364
## License
6465

6566
Cubase Project Plugins is released under the **MIT** license. Please see the

0 commit comments

Comments
 (0)