Skip to content

Commit

Permalink
docs: rewrite README
Browse files Browse the repository at this point in the history 
- Move troubleshooting section to its own README.
- Move legacy installation method with scripts to
its own README in scripts folder.
- Update README with new information on
python package and cleanup.
  • Loading branch information
@mariugul
mariugul committed Aug 12, 2024
1 parent 889517f commit 78df2e8
Show file tree
Hide file tree
Showing 3 changed files with 287 additions and 254 deletions.
Loading

2 comments on commit 78df2e8

@killerbytes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did the windows setup gets removed?

@vicwomg
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did the windows setup gets removed?

Pikaraoke has been refactored to be installed as a command line executable via pip. There is no need to script the setup or launch of pikaraoke anymore. See the readme for full instructions, including windows.

Please sign in to comment.