Skip to content

Commit 1bf59b8

Browse files
committed
docs: update readme
1 parent 0fe9936 commit 1bf59b8

File tree

1 file changed

+42
-10
lines changed

1 file changed

+42
-10
lines changed

README.md

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,48 @@
1-
# where39
1+
# Where 39
22

3-
A new Flutter project.
3+
A simple mapping application that uses words to instead of latitude and longitudes.
44

5-
## Getting Started
5+
Original: https://where39.com / [source](https://github.com/arcbtc/where39)
66

7-
This project is a starting point for a Flutter application.
7+
## Building
88

9-
A few resources to get you started if this is your first Flutter project:
9+
You can follow these instructions to build the app
10+
and install it onto your device.
1011

11-
- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
12+
### Prerequisites
1313

14-
For help getting started with Flutter, view our
15-
[online documentation](https://flutter.dev/docs), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.
14+
If you are new to Flutter, please first follow
15+
the [Flutter Setup](https://flutter.dev/setup/) guide.
16+
17+
### Building and installing the Flutter app
18+
19+
* `cd repository_root/example`
20+
* `flutter pub get`
21+
* `flutter run --release`
22+
23+
The `flutter run --release` command both builds and installs the app.
24+
25+
## Issues
26+
File any issues to the [github issue tracker](https://github.com/fusion44/where39_app/issues)
27+
28+
## Contributing
29+
30+
1. Fork it!
31+
2. Create your feature branch: `git checkout -b my-new-feature`
32+
3. Commit your changes: `git commit -am 'Add some feature'`
33+
4. Push to the branch: `git push origin my-new-feature`
34+
5. Submit a pull request :D
35+
36+
## Screenshots
37+
![Unshuffled seed](/screenshots/marker_unshuffled.png)
38+
![Shuffled seed](/screenshots/marker_shuffled.png)
39+
![Shuffling](/screenshots/shuffle1.png)
40+
![Word entry](/screenshots/word_entry1.png)
41+
42+
## Icon
43+
44+
Android launcher icons were generated using Android Asset Studio:
45+
https://romannurik.github.io/AndroidAssetStudio/icons-launcher.html
46+
47+
## License
48+
See [LICENSE](https://github.com/fusion44/where39_app/blob/master/LICENSE) file (GNU General Public License v3.0)

0 commit comments

Comments
 (0)