Skip to content

Commit

Permalink
feat: Improve readme
Browse files Browse the repository at this point in the history
Rework readme and add images and links around the panoramax project
  • Loading branch information
Jean-BaptisteC committed Jun 23, 2024
1 parent 182dc2f commit d9180c8
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 9 deletions.
48 changes: 39 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,42 @@
# Paranomax Mobile App
<p align="center">
<img src="/assets/logo.jpeg" height="100"/>
</p>
<h1 align="center">Panoramax Mobile App</h1>

Panoramax mobile is an application to capture photo sequences with your mobile and send these sequences to a Panoramax instance.

> [!NOTE]
> The app is under development, a first version is planned soon.
> You can follow progression in this [project](https://github.com/orgs/nobelization/projects/1).
<div align="center">
<!--- <a href="https://f-droid.org/packages/app_id"> --->
<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80" align="center"/>
<!---</a>--->
<!--- <a href="https://play.google.com/store/apps/app_id"> --->
<img src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' alt='Get it on Google Play' height="80" align="center"/>
<!---</a>--->
<!--- <a href="https://apps.apple.com/us/app/app_id"> --->
<img src="assets/apple-appstore.svg" alt="Get it on App Store" height="60" align="center"/>
<!---</a>--->
<a href="https://github.com/nobelization/panoramax-mobile-app/releases/latest/">
<img src="https://user-images.githubusercontent.com/663460/26973090-f8fdc986-4d14-11e7-995a-e7c5e79ed925.png" alt="Download app from GitHub" height="80" align="center"/>
</a>
</div>

# Contribute to the code

## Prerequisites
- Dart
- Docker Engine

## Getting Started

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
This project is developed in Flutter.

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
[online documentation](https://docs.flutter.dev/).
To submit PR on the project, use our [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/)

### Start docker container
```shell
Expand Down Expand Up @@ -51,3 +72,12 @@ dart run build_runner watch --delete-conflicting-outputs
```shell
flutter test integration_test
```
### Documentation
- [Panoramax website](https://panoramax.fr/)
- [Meta catalog](https://api.panoramax.xyz/)
- [Panoramax repository](https://gitlab.com/panoramax/)
- [Topic Panoramax on Forum](https://forum.geocommuns.fr/c/panoramax/6)
Licensed under the AGPL-3.0 license. See [LICENSE](/LICENSE)
46 changes: 46 additions & 0 deletions assets/apple-appstore.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d9180c8

Please sign in to comment.