diff --git a/README.md b/README.md index 75f74f9..0cf492a 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,47 @@ # LoFi Engine

- Icon + Icon

-Generate LoFi music on the go. You create your own atmosphere LoFi Engine sets the mood. +Generate LoFi music on the go. You create your own atmosphere; LoFi Engine sets the mood. ![screenshot](screenshots/screenshot.jpeg) + ## Features 🚀 -* Create your own LoFi studio with your unique music with minimal touches from this and that, be the Artist. -* Works with major desktop platforms *Linux,* *Mac,* and *Windows*. -* Doesn't require internet connection, your experience is fully private. -* LoFi Engine main focus is *customization*, *accessibility* and *artistic freedom*. -### customization +* Create your own LoFi studio with your unique music with minimal touches from this and that. Be the Artist. +* Works with major desktop platforms: **Linux**, **Mac**, and **Windows**. +* Doesn't require an internet connection; your experience is fully private. +* LoFi Engine's main focus is **customization**, **accessibility**, and **artistic freedom**. + +### Customization 1. **Playback**: If you want to listen to music or just listen to birds singing freely, you choose. -2. **Look**: With carefully crafted artworks from talented artists makes the long study session a piece of joy. -3. **Ambience**: A windy evening, or the sound of waves crushing into the sand of a sunny beach brings peace. +2. **Look**: With carefully crafted artworks from talented artists, long study sessions become a joy. +3. **Ambience**: A windy evening or the sound of waves crashing into the sand of a sunny beach brings peace. + ### Accessibility -Any actions or clicks you can do with the mouse there is a shortcut for it with the keyboard. For playback, effects, ambient tracks, look, etc. +Any action or click you can do with the mouse has a shortcut for it with the keyboard. For playback, effects, ambient tracks, look, etc. -All information about the app and **shortcuts** is available in the *info box* accessible via the ==ESC== key. +All information about the app and **shortcuts** is available in the *info box* accessible via the **ESC** key. ![info-box](screenshots/info-box.png) ## Future Plan -At the moment there is only one main LoFi track playing in a loop. For a better and customizable experience the main LoFi track should be generated on the go. The current suitable solution could be done using **Magenta.js**, [learn more!](https://magenta.tensorflow.org/). +At the moment, there is only one main LoFi track playing in a loop. For a better and more customizable experience, the main LoFi track should be generated on the go. The current suitable solution could be done using **Magenta.js**. [Learn more!](https://magenta.tensorflow.org/). -## License -MIT +## Contributing +We welcome contributions from the community! If you're interested in contributing to LoFi Engine, please follow these steps: +1. Fork the repository. +2. Create a new branch for your feature or bugfix. +3. Make your changes and commit them with clear and descriptive messages. +4. Push your changes to your fork. +5. Open a Pull Request to the `main` branch of this repository. +### We Need Your Help with Music Generation! +We are looking for contributors to help with implementing real-time music generation. If you have experience with: +- **Magenta.js** or other music generation libraries +- Real-time audio processing +- Music theory and composition +Please consider contributing to this exciting feature! +## License +MIT