From e3d7eaa6b0ffcc3be5ef8fc713dc66424749e415 Mon Sep 17 00:00:00 2001 From: Ezerous Date: Thu, 20 Jul 2017 22:37:40 +0300 Subject: [PATCH] Doc updates --- CONTRIBUTING.md | 16 +++++++--------- README.md | 8 ++++++++ doc/forum_post.txt | 35 ----------------------------------- 3 files changed, 15 insertions(+), 44 deletions(-) delete mode 100644 doc/forum_post.txt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 44be1c74..6f5733a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,35 +13,33 @@ vulnerabilities, please report them in private to There are many ways of contributing to mTHMMY: -- Simply using the latest release version (anonymous reports are sent automatically) -- Becoming an alpha or beta tester +- Simply using the [latest release version][google-play] from Google Play (anonymous reports are sent automatically) - Joining our [Discord server][discord-server] -- Submiting bugs and ideas on our [Trello board][trello-board] -- Getting code access to fork mTHMMY and submit [merge requests](#merge-requests) +- Submitting bugs and ideas on our [Trello board][trello-board] +- Forking mTHMMY and submitting [merge requests](#merge-requests) - Joining our core team - Contacting us by email at `thmmynolife@gmail.com` ## Issue tracker The [mTHMMY Board on trello.com][trello-board] is used as an Issue Tracker, for bugs and improvements concerning the available mTHMMY releases. -Before creating a card to submit an issue please **[search the board][trello-board]** for similar entries. +Before creating a card to submit an issue please **search the board** for similar entries. ## Merge requests Merge requests with fixes and improvements to mTHMMY are most welcome. Any developer that wants to work independently from the core team can simply follow the workflow below to make a merge request: -1. Request and get access to the repository 1. Fork the project into your personal space on GitLab.com -1. Create a feature branch, branch away from `develop` +1. Create a feature branch, away from `develop` 1. Push the commit(s) to your fork 1. Create a merge request (MR) targeting `develop` [at mTHMMY](https://gitlab.com/ThmmyNoLife/mTHMMY/tree/develop) 1. Fill the MR title describing the change you want to make -1. Fill the MR description with a brief motive for your change and the method you used to achieve it. +1. Fill the MR description with a brief motive for your change and the method you used to achieve it 1. Submit the MR. - +[google-play]: https://play.google.com/store/apps/details?id=gr.thmmy.mthmmy [trello-board]: https://trello.com/invite/b/4MVlkrkg/44a931707bd0b84a5e0bdfc42b9ae4f1/mthmmy [discord-server]: https://discord.gg/CVt3yrn diff --git a/README.md b/README.md index 89f8a134..f27cc28a 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,12 @@ mTHMMY is a mobile app for the [thmmy.gr](https://www.thmmy.gr) community. mTHMMY can be installed on any smartphone with Android 4.4 KitKat or newer. +## Download + +The latest release version is available on Google Play: + +Get it on Google Play + ## Contributing Please refer to [CONTRIBUTING.md](/CONTRIBUTING.md) for details. @@ -20,5 +26,7 @@ Please refer to [CONTRIBUTING.md](/CONTRIBUTING.md) for details. Do not hesitate to contact us for any matter, either by sending an email to `thmmynolife@gmail.com`, or by joining our [Discord server][discord-server]. +**Legal attribution: Google Play and the Google Play logo are trademarks of Google Inc.* + [discord-server]: https://discord.gg/CVt3yrn [trello-board]: https://trello.com/invite/b/4MVlkrkg/44a931707bd0b84a5e0bdfc42b9ae4f1/mthmmy diff --git a/doc/forum_post.txt b/doc/forum_post.txt deleted file mode 100644 index 1957af12..00000000 --- a/doc/forum_post.txt +++ /dev/null @@ -1,35 +0,0 @@ -[center][size=25pt][b]Introduction[/b][/size][/center] - -Από τη συζήτηση [url=https://www.thmmy.gr/smf/index.php?topic=67629.0]εδώ[/url], ξεκίνησε ένα project με στόχο τη δημιουργία εφαρμογής για Android κινητά που θα συγκεντρώνει και θα κάνει πιο εύκολη τη πρόσβαση σε μερικές από τις βασικές σελίδες και υπηρεσίες που αφορούν τη σχολή και χρησιμοποιούμε καθημερινά. - -Μετά από 2+ μήνες δουλειάς και πάνω από 9000 γραμμές κώδικα (.java, .xml και άλλα), σήμερα (16/1/2017) ανεβάσαμε για πρώτη φορά την εφαρμογή (σε closed alpha phase) στο Google Play Store! - -Προς το παρόν η εφαρμογή υποστηρίζει κάποιες από τις βασικές λειτουργίες του forum. Σταδιακά θα ενσωματώνονται όλο και περισσότερες λειτουργίες, για παράδειγμα ενός συστήματος ειδοποιήσεων για νέες ανακοινώσεις του ethmmy και της σελίδας της γραμματείας, instant chat κ.ά., ανάλογα πάντα με τις ιδέες, τη διάθεση και την ενέργεια όσων θα συμμετέχουν. - -Αυτή τη στιγμή με το project ασχολούμαστε εγώ και ο L, ενώ έχουν βοηθήσει ο iason1907 και ο [url=https://www.thmmy.gr/smf/index.php?topic=67565.msg1163192#msg1163192]nohponex[/url]. - -[hr] -[center][size=25pt][b]Κάλεσμα για contributors[/b][/size] - -[img height=200]https://tctechcrunch2011.files.wordpress.com/2015/04/uncle-sam-we-want-you1-kopie_1.png[/img][/center] - -Αν ενδιαφέρεσαι κι [b]ΕΣΥ[/b] να ασχοληθείς με το project μπορείς να το κάνεις με πολλούς τρόπους: -[list] - -[li] -Να αναφέρεις bugs, να προτείνεις βελτιώσεις και να συμμετέχεις σε συζητήσεις στον [url=https://discord.gg/PVRVjth]Discord server[/url] μας και στον Issue Tracker στο [url=trello.com]Trello[/url] (το link του είναι pinned στο #feedback στο Discord). -[/li] -[li] -Να κατεβάσεις και να δοκιμάσεις την alpha έκδοση της εφαρμογής από [url=https://play.google.com/apps/testing/gr.thmmy.mthmmy]εδώ[/url], [b]αφού [/b]πρώτα μας στείλεις το Gmail που έχεις στο Google Play για να αποκτήσεις πρόσβαση. -[/li] -[li] -Να έρθεις σε άμεση επικοινωνία με την ομάδα μέσω του [url=https://discord.gg/PVRVjth]Discord[/url] ή στέλνοντας email στο thmmynolife@gmail.com. -[/li] -[li]Αν ξέρεις προγραμματισμό μπορείς αρχικά να ζητήσεις πρόσβαση στο repository και να συνεισφέρεις κώδικα με fork και merge requests στους ρυθμούς σου. Χρειάζονται [i]άμεσα[/i] νέοι developers για υλοποιήση καινούργιων χαρακτηριστικών, διόρθωση εντόμων, σύνταξη των javadocs και του documentation γενικότερα, white-box testing, υλοποίηση του backend στο server που στήθηκε πρόσφατα και πολλών άλλων. -[/li][/list] -[hr] -[center][size=25pt][b]Η εφαρμογή[/b][/size][/center] - -[center][url=https://s6.postimg.org/v9mseb7n5/image.png][img width=200]https://s6.postimg.org/v9mseb7n5/image.png[/img][/url] [url=https://s6.postimg.org/3nk0tmoa9/image2.png][img width=200]https://s6.postimg.org/3nk0tmoa9/image2.png[/img][/url] [url=https://s6.postimg.org/i813ogj8x/image3.png][img width=200]https://s6.postimg.org/i813ogj8x/image3.png[/img][/url] [url=https://s6.postimg.org/4to0sfckx/image4.png][img width=200]https://s6.postimg.org/4to0sfckx/image4.png[/img][/url] [url=https://s6.postimg.org/69zjakfht/image5.png][img width=200]https://s6.postimg.org/69zjakfht/image5.png[/img][/url] [url=https://s6.postimg.org/rkx3etxm9/image6.png][img width=200]https://s6.postimg.org/rkx3etxm9/image6.png[/img][/url][/center] - -Αυτή τη στιγμή στην εφαρμογή μπορείς να κάνεις login και logout, να δεις τα "Πρόσφατα", να περιηγηθείς στα boards, topics και user profiles, να κατεβάσεις αρχεία από τα downloads και από συνημμένα σε post. \ No newline at end of file