Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewschalk committed Apr 22, 2023
1 parent dbf298a commit 4fd5730
Showing 1 changed file with 1 addition and 8 deletions.
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,11 @@
<p>
<img alt="GitHub" src="https://img.shields.io/github/license/andrewschalk/Nice-Tabs"/>
</p>
A GUI based application that allows users to download Ultimate Guitar tabs and chords into a clean printable PDF. Nice Tabs comes packaged with a compact version of LiveTeX so the user is not required to have a LaTeX compiler installed. This was just a program I made for myself but maybe someone else can get some use from it. No promises that it'll work without issue. If you notice anything wrong, please open an issue. Pull requests are appreciated.
A GUI based application that allows users to download Ultimate Guitar tabs and chords into a clean printable PDF. Nice Tabs comes packaged with a stripped down version of LiveTeX so the user is not required to have a LaTeX compiler installed. This was just a program I made for myself but maybe someone else can get some use from it. No promises that it'll work without issue. If you notice anything wrong, please open an issue. Pull requests are appreciated. Running the code is easy, just use pip to install required modules with requirements.txt.

### Installation Instructions
Tested with Windows 10,11. Go to [Nice Tabs v0.4.1-alpha](https://github.com/andrewschalk/Nice-Tabs/releases/tag/v0.4.1-alpha) and download NiceTabs.exe. Windows may suggest the program is a virus, I can assure you it's not, just hit "more info" and "run anyway". You might not be able to run it directly from your browser after downloading. Depending on your system, Nice Tabs could take a long time to open while it unpacks temporary files, this is a work in progress.

### Developer Instructions
Tested with Windows 10,11(should run on Mac OS or Linux distros if you simply change the web drivers in /src/nice_tabs/processes.py to whatever browser you have installed). To run the program you will need to first clone the repository in your favorite Python IDE and then follow these steps. Requires Python 3.
1. Create virtual environment in the repository's root directory: ```python -m venv venv```
2. Activate the virtual environment and select the virtual environment's python interpreter: The best way to do this will vary based on your IDE. Many IDEs will do this automatically, just start a new terminal after creating a virtual environment.
3. Install required modules to virtual environment:```pip install -r requirements.txt```
4. Run: src/nice_tabs/main.py

### Usage
Simply paste a Ultimate Guitar Tabs URL into the box and hit "create". You will be prompted where to save your PDF.

Expand Down

0 comments on commit 4fd5730

Please sign in to comment.