docs: Add new ReadMe for Hydraulic AppThis commit introduces a new ReadMe file for the Hydraulic app, replacing the existing README.md and README2.md files.The new ReadMe provides a comprehensive overview of the Hydraulic app, including:- Project overview and features - Installation instructions - Download links and badges for Play Store, F-Droid, and GitHub releases - Tech stack and open-source libraries used - Translation information - Contribution guidelines and support options - License informationIt also includes screenshots, logos, and badges for better visual presentation. #180
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…adMe file for the Hydraulic app, replacing the existing README.md and README2.md files.The new ReadMe provides a comprehensive overview of the Hydraulic app, including:- Project overview and features - Installation instructions - Download links and badges for Play Store, F-Droid, and GitHub releases - Tech stack and open-source libraries used - Translation information - Contribution guidelines and support options - License informationIt also includes screenshots, logos, and badges for better visual presentation.
…ile with the correct project name and links to resources.Specifically, the following changes were made:- Updated badges and links to point to the 'hydraulic' repository instead of 'ImageResizer' or 'imageresizer'. - Updated download links and play store links to the correct package name. - Updated the translation platform link. - Updated the contributor link to point to the 'hydraulic' repository.
…ates the translation and analytics links in the README file.Specifically, the following changes were made:- Updated the translation links to point to the correct Hosted Weblate project for Hydraulic. - Updated the analytics image link to the correct Repobeats embed URL.
…ates the translation and analytics links in the README file.Specifically, the following changes were made:- Updated the translation links to point to the correct Hosted Weblate project for Hydraulic. - Updated the analytics image link to the correct Repobeats embed URL.
…the readme badges and moves the image folder in fastlane metadata.Specifically, the following changes were made:- Updated the commits-since badge to point to tag `1.0.0` instead of `v1.0`. - Updated the wakatime badge with a new user ID. - Commented out the play store and f-droid badges. - Renamed the `button` image folder to `buttons` in the fastlane metadata for Android.
…wing changes:- Fixed a typo in the badge section. - Added a line break in the download section to improve readability. - Removed a redundant header section (`#`). - Removed an unnecessary banner image from the README.
change
…n and screenshots for the project.Specifically, the following changes were made:- Updated the app icon to a new design. - Replaced the existing screenshots with new ones. - Updated the app name in the readme.
…hots for the Play Store listing.The screenshots are added for both desktop and web views.Specifically, the following screenshots were added:- 3 desktop screenshots - 3 web screenshots
…owing changes:- Updated the app logo. - Updated the app screenshots. - Removed the app banner.
…e structure and formatting of the README file.Specifically, the following changes were made:- Removed unnecessary line breaks and improved spacing. - Reorganized sections and content for better readability. - Added a dedicated "Screenshot" section. - Updated the download badges and links to use the latest release. - Consolidated the "Features" and "Tech stack" sections. - Removed outdated comments and placeholders. - Improved the overall layout and visual appeal of the README.
…README file by:- Centering elements using CSS styles instead of HTML align attributes. - Adding alt attributes to images for better accessibility. - Using line breaks (br) more consistently. - Removing unnecessary HTML tags and divs.These changes make the README file more visually appealing and easier to read.
…o center the content using flexbox instead of `text-align: center`. It also replaces the old title with `h1` tag.
…o center the image and text.Specifically, the following changes were made:- Replaced `<div style="display: flex; justify-content: center;">` with `<div align="center">` for both the image and the text elements. - Added `width="40%"` to the image tag to set the image width to 40%.
…he formatting and wording in the README file.Specifically, the following changes were made:- Changed `<div style="text-align: center;">` to `<div align="center">` for better readability and consistency. - Updated section headings from `#` to `##` for better hierarchy and visual appeal. - Replaced "Features" with "Features" and "Find this repository useful?" with "Find this repository useful?" for better wording. - Changed "Star History" to "Star History" and "Contributors" to "Contributors" for better wording. - Added line breaks and spacing for improved visual clarity and readability.These changes enhance the overall presentation and clarity of the README file, making it more informative and user-friendly.
…adme file.Specifically, the following changes were made:- Removed the unnecessary div with `text-align: center`. - Wrapped Star History and Repobeats analytics image in a paragraph with `align="center"` for better visual presentation. - Moved Contributors section outside the centered paragraph.
…adme file.Specifically, the following changes were made:- Removed the unnecessary div with `text-align: center`. - Wrapped Star History and Repobeats analytics image in a paragraph with `align="center"` for better visual presentation. - Moved Contributors section outside the centered paragraph.
…adme file.Specifically, the following changes were made:- Removed the unnecessary div with `text-align: center`. - Wrapped Star History and Repobeats analytics image in a paragraph with `align="center"` for better visual presentation. - Moved Contributors section outside the centered paragraph.
… significantly updates the README file to provide detailed information about the project's purpose, build process, release procedures, testing strategies, and performance considerations.Specifically, the following changes were made:- Updated the project description to reflect its nature as a Compose Multiplatform template using a note app example with a multi-module architecture. - Added detailed build instructions for Android (GooglePlay and FossReliant variants), Desktop, and Web platforms. - Included release instructions for each platform, covering build commands, signing, and distribution. - Introduced a comprehensive testing section, detailing JVM tests, Screenshot tests with Paparazzi, and Gradle tasks for automated image comparisons. - Added a performance section outlining the use of benchmarks, Baseline Profiles, and Compose Compiler Metrics to optimize app performance.
…he placement of the logo and title in the README file.Specifically, the logo and the title "Hydraulic Compose Multiplatform Template" have been moved below the introductory text and badges, improving the visual layout and presentation of the README.
…he placement of the logo and title in the README file.Specifically, the logo and the title "Hydraulic Compose Multiplatform Template" have been moved below the introductory text and badges, improving the visual layout and presentation of the README.
…changes:- Clarifies build and run instructions for Android, Desktop and Web. - Updates the instructions for releasing the application on each platform. - Replaces the outdated testing section with information about JVM and screenshot testing. - Removes unnecessary sections and improves formatting for clarity.
…rformance sectionsThis commit updates the ReadMe file with detailed information about screenshots, build instructions for different platforms, release processes, testing methodologies, and performance optimization techniques.Specifically, it:- Adds screenshots for phone, desktop, and web platforms. - Provides build and release instructions for Android (GooglePlay and FossReliant), desktop, and web. - Explains the testing process, including JVM tests, screenshot tests, and Paparazzi integration. - Describes performance optimization strategies using benchmarks, baseline profiles, and Compose Compiler Metrics. - Improves formatting and organization for better readability.
…wing changes:- Adds badges for Kotlin Multiplatform, Jetpack Compose, and Material You. - Includes screenshots for phone, desktop, and web platforms. - Lists the features of the application. - Provides details on the tech stack and open-source libraries used. - Explains the build process for Android, Desktop, and Web. - Describes the release process for each platform. - Covers testing procedures, including JVM tests and screenshot tests. - Addresses performance considerations with benchmarks, baseline profiles, and Compose Compiler Metrics. - Adds a call to action for users to star the repository and follow the author. - Includes a star history chart. - Acknowledges contributors. - States the license information.
…ormation about newly added dependencies, testing libraries, architectural choices, and a database used.Specifically, it adds: - Room, Turbine, Timber, and KSP dependencies. - Information about the MVVM architecture and repository pattern. - A mention of the Room database used.
…uncher icon to a new, simpler design.Specifically, the following changes were made:- Updated the vector drawable for the foreground of the launcher icon (`ic_launcher_foreground.xml`). - Updated all the launcher icons in various resolutions (hdpi, mdpi, xhdpi, xxhdpi, xxxhdpi) with new images. - Updated the play store icon (`ic_launcher-playstore.png`).
…previous icon has been replaced with a new one.
…es the implementation of the `SplashScreen` composable, removing platform-specific implementations and providing a single, shared implementation in the `commonMain` source set.This change eliminates code duplication and simplifies the project structure by using a single source of truth for the splash screen across all platforms. The splash screen now displays a logo, application name, and a background color, ensuring consistent branding across all targets.
…n used for the Google Play Store listing.The previous icon has been replaced with a new icon.
…t updates the `conveyor.conf` file to use a custom icon and name for the application.Specifically, the following changes were made:- Set the `display-name` to "Hydraulic". - Updated the icon to use the letter "H" and a custom brown gradient instead of the previous "SA" icon and blue/pink gradient.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.