Skip to content

Commit

Permalink
docs: Fix logo (and other issues)
Browse files Browse the repository at this point in the history
  • Loading branch information
cpswan committed Feb 27, 2024
1 parent 8e4f505 commit b6888bb
Showing 1 changed file with 34 additions and 28 deletions.
62 changes: 34 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,29 @@
# Private Fit

# Now for a little internet optimism
<a href="https://atsign.com#gh-light-mode-only"><img width=250px src="https://atsign.com/wp-content/uploads/2022/05/atsign-logo-horizontal-color2022.svg#gh-light-mode-only" alt="The Atsign Foundation"></a><a href="https://atsign.com#gh-dark-mode-only"><img width=250px src="https://atsign.com/wp-content/uploads/2023/08/atsign-logo-horizontal-reverse2022-Color.svg#gh-dark-mode-only" alt="The Atsign Foundation"></a>

<img src="https://atsign.dev/assets/img/@dev.png?sanitize=true">
# Private Fit

## Now for a little internet optimism

[![pub package](https://img.shields.io/pub/v/at_app)](https://pub.dev/packages/at_app)
[![pub points](https://badges.bar/at_app/pub%20points)](https://pub.dev/packages/at_app/score)
![coverage][coverage_badge]
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
[![License: MIT][license_badge]][license_link]

Generated by the [at_app CLI](https://github.com/atsign-foundation/at_app) and [Very Good CLI][very_good_cli_link] 🤖
Generated by the [at_app CLI](https://github.com/atsign-foundation/at_app)
and [Very Good CLI][very_good_cli_link] 🤖

A secure fitness app.

---

## Getting Started 🚀



This project contains 3 flavors:

- development
- staging
- production

To run the desired flavor either use the launch configuration in VSCode/Android Studio or use the following commands:
To run the desired flavor either use the launch configuration in
VSCode/Android Studio or use the following commands:

```sh
# Development
Expand All @@ -52,7 +48,8 @@ To run all unit and widget tests use the following command:
$ flutter test --coverage --test-randomize-ordering-seed random
```

To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov).
To view the generated coverage report you can use
[lcov](https://github.com/linux-test-project/lcov).

```sh
# Generate Coverage Report
Expand All @@ -66,11 +63,14 @@ $ open coverage/index.html

## Working with Translations 🌐

This project relies on [flutter_localizations][flutter_localizations_link] and follows the [official internationalization guide for Flutter][internationalization_link].
This project relies on [flutter_localizations][flutter_localizations_link]
and follows the
[official internationalization guide for Flutter][internationalization_link].

### Adding Strings

1. To add a new localizable string, open the `app_en.arb` file at `lib/l10n/arb/app_en.arb`.
1. To add a new localizable string, open the `app_en.arb` file at
`lib/l10n/arb/app_en.arb`.

```arb
{
Expand Down Expand Up @@ -112,16 +112,17 @@ Widget build(BuildContext context) {

### Adding Supported Locales

Update the `CFBundleLocalizations` array in the `Info.plist` at `ios/Runner/Info.plist` to include the new locale.
Update the `CFBundleLocalizations` array in the `Info.plist` at
`ios/Runner/Info.plist` to include the new locale.

```xml
...

<key>CFBundleLocalizations</key>
<array>
<string>en</string>
<string>es</string>
</array>
<array>
<string>en</string>
<string>es</string>
</array>

...
```
Expand All @@ -130,7 +131,7 @@ Update the `CFBundleLocalizations` array in the `Info.plist` at `ios/Runner/Info

1. For each supported locale, add a new ARB file in `lib/l10n/arb`.

```
```text
├── l10n
│ ├── arb
│ │ ├── app_en.arb
Expand Down Expand Up @@ -166,25 +167,32 @@ Update the `CFBundleLocalizations` array in the `Info.plist` at `ios/Runner/Info
## Open source usage and contributions

This is open source code, so feel free to use it as is, suggest changes or
enhancements or create your own version. See [CONTRIBUTING.md](./CONTRIBUTING.md)
for detailed guidance on how to setup tools, tests and make a pull request.
enhancements or create your own version. See
[CONTRIBUTING.md](./CONTRIBUTING.md) for detailed guidance on how to setup
tools, tests and make a pull request.

## Acknowledgement/attribution

This project idea came from a hackathon and the repo was created by [Kelvin Zawadi](https://github.com/kzawadi).
This project idea came from a hackathon and the repo was created by
[Kelvin Zawadi](https://github.com/kzawadi).

### Copyright notice

Copyright 2014 The Flutter Authors. All rights reserved.

This project has copied some variables from the `flutter create` tool in order to give developers a familiar experience.
This project has copied some variables from the `flutter create` tool in
order to give developers a familiar experience.
Variables have been annotated with the copyright.

Please see the original license [here](https://github.com/flutter/flutter/blob/master/LICENSE).
Please see the original license
[here](https://github.com/flutter/flutter/blob/master/LICENSE).

## Maintainers

This project is currently maintained by [Jatin Pandya](https://github.com/Jatinpandya26), [Tinashe Seremwe](https://github.com/tinashe404) and [Kelvin Zawadi](https://github.com/kzawadi)
This project is currently maintained by
[Jatin Pandya](https://github.com/Jatinpandya26),
[Tinashe Seremwe](https://github.com/tinashe404) and
[Kelvin Zawadi](https://github.com/kzawadi)

[coverage_badge]: coverage_badge.svg
[flutter_localizations_link]: https://api.flutter.dev/flutter/flutter_localizations/flutter_localizations-library.html
Expand All @@ -194,5 +202,3 @@ This project is currently maintained by [Jatin Pandya](https://github.com/Jatinp
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
[very_good_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli


0 comments on commit b6888bb

Please sign in to comment.