Skip to content

Commit

Permalink
Readme additions and reformatting (powertab#452)
Browse files Browse the repository at this point in the history
* added table of contents

testing readme change

readme additions - table of contents, about us, reformatting

* Capitalization per comments on pr
  • Loading branch information
adam-eldredge committed Oct 1, 2023
1 parent ae699bb commit 32970f9
Showing 1 changed file with 55 additions and 10 deletions.
65 changes: 55 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,69 @@
# Power Tab Editor
<h1 align="center">
<b>
Power Tab Editor
</b>
</h1>

[![Build Status](https://github.com/powertab/powertabeditor/workflows/Build/badge.svg)](https://github.com/powertab/powertabeditor/actions)
<p align="center"> Guitar tablature viewer and editor </p>
<p align="center"><a href="https://powertab.github.io/"><b>Visit our website</b></a></p>

[![Translation status](https://hosted.weblate.org/widgets/powertabeditor/-/powertabeditor/287x66-white.png)](https://hosted.weblate.org/engage/powertabeditor/)
<div align="center">

[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/powertabeditor)
<a href='https://flathub.org/apps/details/com.github.powertab.powertabeditor'><img width='185' height='58' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-en.png'/></a>
[![Build Status](https://github.com/powertab/powertabeditor/workflows/Build/badge.svg)](https://github.com/powertab/powertabeditor/actions)

### Users
[![Translation status](https://hosted.weblate.org/widgets/powertabeditor/-/powertabeditor/287x66-white.png)](https://hosted.weblate.org/engage/powertabeditor/)

[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/powertabeditor)
<a href='https://flathub.org/apps/details/com.github.powertab.powertabeditor'><img width='185' height='58' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-en.png'/></a>
</div>


## Table of Contents

- [About](#about-power-tab-editor)
- [Key Features](#key-features)
- [Supported File Types](#supported-file-types)
- [Users](#users)
- [Developers](#developers)
- [Dependencies](#dependencies)
- [Building](#building)
- [Windows](#windows)
- [Linux](#linux)
- [OS X](#os-x)


## About Power Tab Editor
Power Tab Editor 2.0 - A powerful cross platform guitar tablature viewer and editor inspired by the ceased development and missing source code from the original [Power Tab Editor](http://www.power-tab.net/guitar.php). This project is open-source and written from scratch so that your favorite tabbing platform can continuously grow with your needs.

### Key Features
- Cross platform - Windows, Mac, & Linux
- Tabbed layout for opening multiple files at the same time
- Mixer interface for adjusting volumes during playback
- Complete customization of keyboard shortcuts
- Importing of Guitar Pro tabs

### Supported File Types
- .pt2
- .ptb
- .gp3, .gp4, .gp5
- .gpx
- .gp

## Users
* New user? Read the [intro page](https://github.com/powertab/powertabeditor/wiki/Power-Tab-Editor-2.0,-Here-at-last!) to learn more about the project!
* You can get the latest stable releases from our [downloads page](https://github.com/powertab/powertabeditor/releases). The latest development releases can be downloaded from the [actions page](https://github.com/powertab/powertabeditor/actions) (requires a GitHub login to download).
* Download:
- Latest stable releases [ here ](https://github.com/powertab/powertabeditor/releases)
- Latest development releases [ here ](https://github.com/powertab/powertabeditor/actions) (requires a GitHub login to download)
* You can report bugs or suggest features on our [issue tracker](https://github.com/powertab/powertabeditor/issues), or discuss ideas on the [discussions forum](https://github.com/powertab/powertabeditor/discussions)
* You can [translate](https://hosted.weblate.org/engage/powertabeditor/) the project into your language.
* Join the [Discord community](https://discord.gg/mpXfquuzxe)

### Developers
## Developers
* Development help is very welcome! If you're interested in contributing, the issue tracker has a list of [good first issues](https://github.com/powertab/powertabeditor/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) that are easier to dive into!
* Feel free to ask development-related questions on the [discussions page](https://github.com/powertab/powertabeditor/discussions) or on [Discord](https://discord.gg/mpXfquuzxe)
* See below for instructions on how to compile and run the project:

#### Dependencies:
### Dependencies:
* [CMake](http://www.cmake.org/) >= 3.12
* [Boost](http://www.boost.org/) >= 1.65
* algorithm
Expand All @@ -42,12 +86,13 @@
* (Linux only) - MIDI sequencer (e.g. `timidity-daemon`)
* A compiler with C++17 support.

### Building:
#### Windows:
* Install Git - see https://help.github.com/articles/set-up-git
* Install [vcpkg](https://github.com/microsoft/vcpkg) and run `vcpkg install --triplet x64-windows boost-algorithm boost-date-time boost-endian boost-functional boost-iostreams boost-range boost-rational boost-signals2 boost-stacktrace doctest minizip nlohmann-json pugixml` to install dependencies.
* Install Qt by running `vcpkg install --triplet x64-windows qt5-base qt5-tools` (this may take a while), or install a binary release from the Qt website or https://github.com/miurahr/aqtinstall.
* Open the project folder in Visual Studio and build.
* If running CMake manually, set `CMAKE_TOOLCHAIN_FILE` to `[vcpkg root]\scripts\buildsystems\vcpkg.cmake`).
* If running CMake manually, set `CMAKE_TOOLCHAIN_FILE` to `[vcpkg root]\scripts\buildsystems\vcpkg.cmake`

#### Linux:
* These instructions assume a recent Ubuntu/Debian-based system, but the package names should be similar for other package managers.
Expand Down

0 comments on commit 32970f9

Please sign in to comment.