read me file improvement.

development
Sikander Saleem 5 years ago
parent ff8c972d12
commit 04e8377c89

@ -1,16 +1,24 @@
# tangheem
A new Flutter application.
# Tangheem
## Getting Started
A Flutter application to read Quran and view Tangheem on it.
This project is a starting point for a Flutter application.
## Flutter Dependency
A few resources to get you started if this is your first Flutter project:
- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
There are some important information regarding Project
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.
- Based on flutter v2.0 or above
## Coding Guide Lines:
- Set android studio 200 as words per line (Setting>Editor>Coding style>Dart) to avoid file format conflicts among all team members.
- Must format file whenever perform git push
- Folder naming should be lowercase e.g. folder_name
- File naming should be lowercase e.g. file_name
- Class naming should be first letter uppercase e.g. ClassName
- Function name should be very clear to understand and should be camelCase e.g. funtionName
- Variable names should be very clear which conveys the proper meaning of its use, to make code reading fast and easy to read by everyone.
- Variable naming should be camelCase e.g. variableName;
- Define variable scope if it only uses in a limited class or function make it private to avoid conflicts.
- Make a personal git change list if you are working on a file for test purposes. (to avoid that test changes when you git push)
- avoid using too many packages if only a few functionalities required (Copy that separate code from the package file and then use this code)

Loading…
Cancel
Save