onsong-parser-go

About The Project

A parser for .onsong files to create .html files, made with go. Inspired by Onsong-Parser (in Haskell) and written for its static site generator (Onsong-SSG) to create an inteface for a large onsong-library hosted on a raspberry pi. To share songs with others in a gathering using a wireless network.

(back to top)

Built With

• Go

(back to top)

Getting Started

Prerequisites

Go Installation

Installation

Clone the repo: git clone https://github.com/jmb05/onsong-parser-go/ Then either:

• To build the project and create an executable in the project directory, run go build
• To build the project and create an executable in $GOPATH/bin/, run go install

(back to top)

Usage

• To convert files use onsong-parser-go "/path/to/file1.onsong" "/path/to/file2.onsong"
• To convert all onsong files inside a directory use onsong-parser-go "/path/to/directory" To include all subdirectories add the -r option

(back to top)

Roadmap

• Add OnSong formatting

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the BSD 3 License. See LICENSE.txt for more information.

(back to top)

Contact

Jared M. Bennett - jmb05@web.de

Project Link: https://github.com/jmb05/Onsong-Parser-go

(back to top)

Acknowledgments

• Original Project in Haskell
• README Template

(back to top)