Skip to content

Commit

Permalink
main: Finalize and update README
Browse files Browse the repository at this point in the history
Change-Id: I39500c4193e3d37a6682042977f7c5d28e5e66ce
  • Loading branch information
sajidshahriar72543 committed Oct 11, 2022
1 parent e6eac8c commit ac94b39
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,27 @@
# flutter_ci
<div style="text-align: justify">

A new Flutter project.
# Flutter CI

## Getting Started
### A very basic continuous integration and automated release of any flutter project using github actions and linux build system.

This project is a starting point for a Flutter application.
<br>

A few resources to get you started if this is your first Flutter project:
## How to use?
- Fork this repo
- Add secret to your repo. For that you need to make a secret in github named ```TOKEN``` and add your github token as key to that secret.
- Make necessary changes to your files
- Save and commit with proper commit message
- As soon as you push to remote repo, it will start the build automatically and after completing it'll release the apks with source code under a proper release tag

- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
## Notes
- It compiles for only android by default. For ios, you'll need to add it's corresponding run command to the build_app job.
- It uses Java 12.x by default.
- Probably all fixes are done already. Any other additions from you guys are always welcomed :)

For help getting started with Flutter, view our
[online documentation](https://flutter.dev/docs), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
<br>

```
Hope you like my work.
Cheers!
```
---

0 comments on commit ac94b39

Please sign in to comment.