From 22e699398e96d695663a41428eeda96e7d52e19c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8C=C3=A1bera?= Date: Fri, 18 May 2018 01:45:48 +0200 Subject: [PATCH 01/13] Update Markdown files - Fix links - No need to load icons from http when there are in repo. - Honor **[MD014](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md014---dollar-signs-used-before-commands-without-showing-output)** --- .editorconfig | 7 +- .github/CONTRIBUTING.md | 11 +- .gitignore | 17 ++- CONTRIBUTING.md | 152 ++++++++----------- README.md | 317 ++++++++++++++++++++-------------------- app/Readme.md | 14 +- 6 files changed, 249 insertions(+), 269 deletions(-) diff --git a/.editorconfig b/.editorconfig index 59b8db48..d52dd70c 100644 --- a/.editorconfig +++ b/.editorconfig @@ -10,6 +10,11 @@ insert_final_newline = true indent_style = tab tab_width = 2 -[*{yml,yaml}] +[*.{yml,yaml}] indent_style = space indent_size = 2 + +[*.{md}] +indent_style = space +indent_size = 4 +trim_trailing_whitespace = false diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a1bcd202..b714967a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,10 +1,12 @@ +# Contributing + ## Submitting issues -* Please search the existing issues first, it's likely that your issue was already reported or even fixed. +- Please search the existing issues first, it's likely that your issue was already reported or even fixed. - Go to "Issues" and type any word in the top search/command bar. - Consider to search on closed issues. To do that just remove "is:open" from the search field. - More info on [search syntax within github](https://help.github.com/articles/searching-issues) -* Report the issue using our [template][template], it includes all the information we need to track down the issue. +- Report the issue using our [template][template], it includes all the information we need to track down the issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. @@ -27,6 +29,7 @@ We have a great community in [Gitter][gitter] that can help you with any doubt o Feel free to create pull requests to help us offer a great and complete software. :wink: ## Translations -Please submit translations via [Transifex][transifex]. -[transifex]: https://www.transifex.com/rambox/rambox-app/ +Please submit translations via [Crowdin][crowdin]. + +[crowdin]: https://crowdin.com/project/rambox/ diff --git a/.gitignore b/.gitignore index e5c535d3..43ccc544 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,10 @@ # Sencha (ExtJS) -/build/development -/build/production -/build/temp +build/development/ +build/production/ +build/temp/ .sass-cache/ .sass_cache/ -/dist +dist/ # OS generated files # ###################### @@ -18,8 +18,8 @@ Thumbs.db # IDE generated files # ###################### -.project -.idea +.project/ +.idea/ # bootstrap files are regenerated by Sencha CMD on every build or refresh bootstrap.js @@ -27,11 +27,12 @@ bootstrap.css bootstrap.json # Electron -node_modules +node_modules/ npm-debug.log # Vagrant -/.vagrant +.vagrant/ + env.js rambox_cfg.json languages.js diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08506148..ab6c88aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,16 +3,12 @@ We welcome pull requests! Follow these steps to contribute: 1. Find an [issue](https://github.com/saenzramiro/rambox/issues) that needs assistance. +1. Let us know you are working on it by posting a comment on the issue. +1. Follow the [Contribution Guidelines](#contribution-guidelines) to start working on the issue. -2. Let us know you are working on it by posting a comment on the issue. +Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) -3. Follow the [Contribution Guidelines](#contribution-guidelines) to start working on the issue. - -Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub] - -(https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) - -###### If you've found a bug that is not on the board, [follow these steps](README.md#found-a-bug). +##### If you've found a bug that is not on the board, [follow these steps](README.md#found-a-bug). -------------------------------------------------------------------------------- @@ -41,10 +37,10 @@ Working on your first Pull Request? You can learn how from this *free* series [H ### Prerequisites -| Prerequisite | Version | -| ------------------------------------------------------------- | ------- | -| [Sencha](https://www.sencha.com/products/extjs/cmd-download/) | `=6.1.2.15` | -| [Ruby](https://www.ruby-lang.org/en/downloads/) | `=2.3` | +| Prerequisite | Version | +| ------------------------------------------------------------- | ----------- | +| [Sencha](https://www.sencha.com/products/extjs/cmd-download/) | `=6.1.2.15` | +| [Ruby](https://www.ruby-lang.org/en/downloads/) | `=2.3` | | [Node.js](http://nodejs.org) | `~ ^4.0.0` | | npm (comes with Node) | `~ ^3.8.7` | @@ -65,21 +61,21 @@ If your versions are lower than the prerequisite versions, you should update. #### Setting Up Your System 1. Install [Git](https://git-scm.com/) or your favorite Git client. -2. (Optional) [Setup an SSH Key](https://help.github.com/articles/generating-an-ssh-key/) for GitHub. +1. (Optional) [Setup an SSH Key](https://help.github.com/articles/generating-an-ssh-key/) for GitHub. #### Forking rambox 1. Go to the top level rambox repository: -2. Click the "Fork" Button in the upper right hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/)) -3. After the repository (repo) has been forked, you will be taken to your copy of the rambox repo at +1. Click the "Fork" Button in the upper right hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/)) +1. After the repository (repo) has been forked, you will be taken to your copy of the rambox repo at #### Cloning Your Fork 1. Open a Terminal / Command Line / Bash Shell in your projects directory (_i.e.: `/yourprojectdirectory/`_) -2. Clone your fork of rambox +1. Clone your fork of rambox ```shell -$ git clone https://github.com/yourUsername/rambox.git +git clone https://github.com/yourUsername/rambox.git ``` **(make sure to replace `yourUsername` with your GitHub username)** @@ -89,10 +85,10 @@ This will download the entire rambox repo to your projects directory. #### Setup Your Upstream 1. Change directory to the new rambox directory (`cd rambox`) -2. Add a remote to the official rambox repo: +1. Add a remote to the official rambox repo: ```shell -$ git remote add upstream https://github.com/saenzramiro/rambox.git +git remote add upstream https://github.com/saenzramiro/rambox.git ``` Congratulations, you now have a local copy of the rambox repo! @@ -103,7 +99,7 @@ Before you start working, you will need to create a separate branch specific to #### Naming Your Branch -Name the branch something like `fix/xxx` or `feature/xxx` where `xxx` is a short description of the changes or feature you are attempting to add. For example +Name the branch something like `fix/xxx` or `feature/xxx` where `xxx` is a short description of the changes or feature you are attempting to add. For example `fix/email-login` would be a branch where you fix something specific to email login. @@ -112,13 +108,13 @@ Name the branch something like `fix/xxx` or `feature/xxx` where `xxx` is a short To create a branch on your local machine (and switch to this branch): ```shell -$ git checkout -b [name_of_your_new_branch] +git checkout -b [name_of_your_new_branch] ``` and to push to GitHub: ```shell -$ git push origin [name_of_your_new_branch] +git push origin [name_of_your_new_branch] ``` **If you need more help with branching, take a look at [this](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches).** @@ -145,12 +141,13 @@ cp env-sample.js env.js # Windows copy env-sample.js env.js ``` + Then edit the `env.js` file and modify the API keys only for services that you will use. ```bash -# Compile the files... -$ sencha app watch -$ npm start # in a new terminal +# Compile the files... +sencha app watch +npm start # in a new terminal ``` ### Make Changes @@ -159,12 +156,10 @@ This bit is up to you! #### How to find the code in the rambox codebase to fix/edit -The best way to find out any code you wish to change/add or remove is using -the GitHub search bar at the top of the repository page. For example, you could -search for a challenge name and the results will display all the files along -with line numbers. Then you can proceed to the files and verify this is the area -that you were looking forward to edit. Always feel free to reach out to the chat -room when you are not certain of any thing specific in the code. +The best way to find out any code you wish to change/add or remove is using the GitHub search bar at the top of the repository page. +For example, you could search for a challenge name and the results will display all the files along with line numbers. +Then you can proceed to the files and verify this is the area that you were looking forward to edit. +Always feel free to reach out to the chat room when you are not certain of any thing specific in the code. #### Adding or Editing Services @@ -178,71 +173,46 @@ To see these changes you'll need to stop your `npm start` and `sencha app watch` #### What is a Pull Request? -A pull request (PR) is a method of submitting proposed changes to the rambox -repo (or any repo, for that matter). You will make changes to copies of the -files which make up rambox in a personal fork, then apply to have them -accepted by rambox proper. +A pull request (PR) is a method of submitting proposed changes to the rambox repo (or any repo, for that matter). +You will make changes to copies of thefiles which make up rambox in a personal fork, then apply to have them accepted by rambox proper. #### Important: ALWAYS EDIT ON A BRANCH -Take away only one thing from this document: Never, **EVER** -make edits to the `staging` branch. ALWAYS make a new branch BEFORE you edit -files. This is critical, because if your PR is not accepted, your copy of -staging will be forever sullied and the only way to fix it is to delete your -fork and re-fork. +Take away only one thing from this document: Never, **EVER** make edits to the `staging` branch. +ALWAYS make a new branch BEFORE you edit files. +This is critical, because if your PR is not accepted, your copy of staging will be forever sullied and the only way to fix it is to delete your fork and re-fork. ### Common Steps -1. Once the edits have been committed, you will be prompted to create a pull - request on your fork's GitHub Page. - -2. By default, all pull requests should be against the rambox main repo, `staging` - branch. - **Make sure that your Base Fork is set to saenzramiro/rambox when raising a Pull Request.** - -3. Submit a pull request. - -4. The title (also called the subject) of your PR should be descriptive of your - changes and succinctly indicates what is being fixed. - - - **Do not add the issue number in the PR title or commit message.** - - - Examples: `Added Service servicename` `Correct typo in menu` - -5. In the body of your PR include a more detailed summary of the changes you - made and why. - - - If the PR is meant to fix an existing bug/issue then, at the end of - your PR's description, append the keyword `closes` and #xxxx (where xxxx - is the issue number). Example: `closes #1337`. This tells GitHub to - close the existing issue, if the PR is merged. - -6. Indicate if you have tested on a local copy of the site or not. +1. Once the edits have been committed, you will be prompted to create a pull request on your fork's GitHub Page. +1. By default, all pull requests should be against the rambox main repo, `staging` branch. + - **Make sure that your Base Fork is set to saenzramiro/rambox when raising a Pull Request.** +1. Submit a pull request. +1. The title (also called the subject) of your PR should be descriptive of your changes and succinctly indicates what is being fixed. + - **Do not add the issue number in the PR title or commit message.** + - Examples: `Added Service servicename` `Correct typo in menu` +1. In the body of your PR include a more detailed summary of the changes you made and why. + - If the PR is meant to fix an existing bug/issue then, at the end of your PR's description, append the keyword `closes` and #xxxx (where xxxx is the issue number). + - Example: `closes #1337`. This tells GitHub to automatically close the existing issue, if the PR is merged. +1. Indicate if you have tested on a local copy of the site or not. ### How We Review and Merge Pull Requests -rambox has a team of volunteer Issue Moderators. These Issue Moderators routinely go through open pull requests in a process called [Quality Assurance] - -(https://en.wikipedia.org/wiki/Quality_assurance) (QA). - -1. If an Issue Moderator QA's a pull request and confirms that the new code does what it is supposed without seeming to introduce any new bugs, they will comment +Rambox has a team of volunteer Issue Moderators. These Issue Moderators routinely go through open pull requests in a process called [Quality Assurance](https://en.wikipedia.org/wiki/Quality_assurance) (QA). -"LGTM" which means "Looks good to me." +1. If an Issue Moderator QA's a pull request and confirms that the new code does what it is supposed without seeming to introduce any new bugs, they will comment: `"LGTM" which means "Looks good to me."` +1. Another Issue Moderator will QA the same pull request. + - Once they have also confirmed that the new code does what it is supposed to without seeming to introduce any new bugs, they will merge the pull request. -2. Another Issue Moderator will QA the same pull request. Once they have also confirmed that the new code does what it is supposed to without seeming to introduce - -any new bugs, they will merge the pull request. - -If you would like to apply to join our Issue Moderator team - which is a Core Team position - message [@BerkeleyTrue](https://gitter.im/berkeleytrue) with links - -to 5 of your pull requests that have been accepted and 5 issues where you have helped someone else through commenting or QA'ing. +If you would like to apply to join our Issue Moderator team - which is a Core Team position - message [@BerkeleyTrue](https://gitter.im/berkeleytrue) with links to 5 of your pull requests that have been accepted and 5 issues where you have helped someone else through commenting or QA'ing. ### How We Close Stale Issues We will close any issues or pull requests that have been inactive for more than 15 days, except those that match the following criteria: -- bugs that are confirmed -- pull requests that are waiting on other pull requests to be merged -- features that are a part of a GitHub project + +- Bugs that are confirmed +- Pull requests that are waiting on other pull requests to be merged +- Features that are a part of a GitHub project ### Next Steps @@ -251,21 +221,17 @@ We will close any issues or pull requests that have been inactive for more than Once your PR is accepted, you may delete the branch you created to submit it. This keeps your working fork clean. -You can do this with a press of a button on the GitHub PR interface. You can -delete the local copy of the branch with: `git branch -D branch/to-delete-name` +You can do this with a press of a button on the GitHub PR interface. You can delete the local copy of the branch with: `git branch -D branch/to-delete-name` #### If your PR is rejected -Don't despair! You should receive solid feedback as to -why it was rejected and what changes are needed. +Don't despair! You should receive solid feedback as to why it was rejected and what changes are needed. -Many Pull Requests, especially first Pull Requests, require correction or -updating. If you have used the GitHub interface to create your PR, you will need -to close your PR, create a new branch, and re-submit. +Many Pull Requests, especially first Pull Requests, require correction or updating. +If you have used the GitHub interface to create your PR, you will need to close your PR, create a new branch, and re-submit. -If you have a local copy of the repo, you can make the requested changes and -amend your commit with: `git commit --amend` This will update your existing -commit. When you push it to your fork you will need to do a force push to -overwrite your old commit: `git push --force` +If you have a local copy of the repo, you can make the requested changes and amend your commit with: `git commit --amend` This will update your existing +commit. +When you push it to your fork you will need to do a force push to overwrite your old commit: `git push --force` -Be sure to post in the PR conversation that you have made the requested changes. \ No newline at end of file +Be sure to post in the PR conversation that you have made the requested changes. diff --git a/README.md b/README.md index 90bbcef5..293ac1c6 100644 --- a/README.md +++ b/README.md @@ -1,163 +1,164 @@ -

-
- Rambox -
- Rambox -
-
-

- -

Free, Open Source and Cross Platform messaging and emailing app that combines common web applications into one.

- -

- Donate with PayPal - GNU GPL v3 - Gitter - Release - -

-

- Travis CI - AppVeyor CI - - -

- -
Available for Windows, Mac and Linux.
- -
DOWNLOAD HERE
- -
Logo designed by Andriy Yurchenko
- ----------- +
+

+
+ Rambox
+ Rambox +

+

+ +

Free, Open Source and Cross Platform messaging and emailing app that combines common web applications into one.

+ +

+ Donate with PayPal + GNU GPL v3 + Gitter + + Release + + +

+

+ Travis CI + AppVeyor CI + + +

+ +
Available for Windows, Mac and Linux.
+ +
DOWNLOAD HERE
+ +
Logo designed by Andriy Yurchenko
+
+ +--- ## Table of Contents +- [Table of Contents](#table-of-contents) - [Screenshot](#screenshot) -- [Services available - 89](#services-available---95) +- [Services available - 98](#services-available---98) - [Features](#features) - [Privacy](#privacy) - [Donations](#donations) - [Translations](#translations) - [Install on Linux - Steps](#install-on-linux---steps) -- [To Do](#to-do) - [Contributing](#contributing) + - [Quickstart](#quickstart) - [Disclosure](#disclosure) - [Licence](#licence) ----------- +--- ## Screenshot -![Rambox](https://raw.githubusercontent.com/saenzramiro/rambox/master/resources/screenshots/mac.png) - +![Rambox](./resources/screenshots/mac.png) ## Services available - 98 -WhatsApp -Messenger -Skype -Slack -Hangouts -Telegram -WeChat -Gmail -Inbox -HipChat -Allo - -ChatWork -GroupMe -Grape -Gitter -Steam -Discord -Noysi -Outlook -Outlook 365 -TutaNota - -Hushmail -BearyChat -Aol -Sync -Wire -Rocket Chat -Missive -Yahoo! Mail -Ryver - -Yandex Mail -Dasher -DingTalk -FlowDock -Mattermost -Voxer -Glip -Yahoo! Messenger -mysms -ICQ - -TweetDeck -Zinc -FreeNode -MightyText -Zoho Email -Zoho Chat -Roundcube -Horde -SquirrelMail -Zimbra - -Hootsuite -Amium -RainLoop -iCloud Mail -IRC Cloud -Kiwi IRC -Smooch -Crisp -Flock -Openmailbox - -Typetalk -Drift -Cisco Spark -Fleep -Socialcast -Riot -Pushbullet -Movim - -Kaiwa -Zyptonite -LinkedIn -The Lounge -Kezmo -Teams -Xing -Workplace -FastMail -Hibox -Jandi -Threema -Messenger for Pages -VK Messenger -Mastodon -Teamwork Chat -ClockTweets -Intercom -Voice -Sandstorm -Gadu-Gadu -Mail.Ru -Kune -Zulip -Stride -Hangouts Chat -Messenger for Business - -











































+WhatsApp +Messenger +Skype +Slack +Hangouts +Telegram +WeChat +Gmail +Inbox +HipChat +Allo + +ChatWork +GroupMe +Grape +Gitter +Steam +Discord +Noysi +Outlook +Outlook 365 +TutaNota +Hushmail + +BearyChat +Aol +Sync +Wire +Rocket Chat +Missive +Yahoo! Mail +Ryver +Yandex Mail +Dasher +DingTalk + +FlowDock +Mattermost +Voxer +Glip +Yahoo! Messenger +mysms +ICQ +TweetDeck +Zinc +FreeNode +MightyText + +Zoho Email +Zoho Chat +Roundcube +Horde +SquirrelMail +Zimbra +Hootsuite +Amium +RainLoop +iCloud Mail +IRC Cloud + +Kiwi IRC +Smooch +Crisp +Flock +Openmailbox +Typetalk +Drift +Cisco Spark +Fleep +Socialcast +Riot + +Pushbullet +Movim +Kaiwa +Zyptonite +LinkedIn +The Lounge +Kezmo +Teams +Xing +Workplace +FastMail + +Hibox +Jandi +Threema +Messenger for Pages +VK Messenger +Mastodon +Teamwork Chat +ClockTweets +Intercom +Voice +Sandstorm + +Gadu-Gadu +Mail.Ru +Kune +Zulip +Stride +Hangouts Chat +Messenger for Business ## Features @@ -181,28 +182,32 @@ No personal information will be saved -Sessions will persist using the [partition:persist](https://electronjs.org/docs/api/webview-tag#partition) attribute for Webviews. So every time you open Rambox, your sessions will keep alive until you remove the service. +Sessions will persist using the [partition:persist](https://electronjs.org/docs/api/webview-tag#partition) attribute for Webviews. +So every time you open Rambox, your sessions will keep alive until you remove the service. -Sync feature use Auth0 for Single Sign On & Token Based Authentication and to store the services that user is using (and the configuration for each service). You are always welcome to check the code! ;) +Sync feature use Auth0 for Single Sign On & Token Based Authentication and to store the services that user is using (and the configuration for each service). +You are always welcome to check the code! ;) ## Donations -| Type | URL/Wallet | -|--------------------|:------------------------------------------------------------------------------------------:| -| PayPal | [HERE](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=WU75QWS7LH2CA) | -| Cryptocurrencies | [HERE](https://www.vaulty.io/v/b6480279-af28-4855-868c-17e5cb0ae7fa) | +| Type | URL/Wallet | +| ---------------- | :----------------------------------------------------------------------------------------: | +| PayPal | [HERE](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=WU75QWS7LH2CA) | +| Cryptocurrencies | [HERE](https://www.vaulty.io/v/b6480279-af28-4855-868c-17e5cb0ae7fa) | ## Translations -Help us translate Rambox on https://crowdin.com/project/rambox/invite. +Help us translate Rambox on . ## [Install on Linux - Steps](https://github.com/saenzramiro/rambox/wiki/Install-on-Linux) -## Contributing +## [Contributing](./CONTRIBUTING.md) -Want to report a bug, request a feature, contribute to or translate Rambox? We need all the help we can get! Fork and work! +Want to report a bug, request a feature, contribute to or translate Rambox? +We need all the help we can get! +Fork and work! -### Quickstart: +### Quickstart ```shell git clone https://github.com/saenzramiro/rambox.git @@ -214,16 +219,14 @@ sencha app watch npm start ``` -See [Contributing.md](https://github.com/saenzramiro/rambox/blob/master/CONTRIBUTING.md) for more detailed information about getting set up. +See [Contributing.md](./CONTRIBUTING.md) for more detailed information about getting set up. -------------------- +--- -Disclosure -------------------- +## Disclosure Rambox is not affiliated with any of the messaging apps offered. -Licence -------------------- +## Licence [GNU GPL v3](https://github.com/saenzramiro/rambox/LICENSE) diff --git a/app/Readme.md b/app/Readme.md index 4942954b..2b351cb2 100644 --- a/app/Readme.md +++ b/app/Readme.md @@ -1,7 +1,7 @@ # ./controller This folder contains the application's global controllers. ViewControllers are located -alongside their respective view class in `"./view"`. These controllers are used for routing +alongside their respective view class in `./view`. These controllers are used for routing and other activities that span all views. # ./model @@ -15,11 +15,13 @@ application's architecture. Pure MVC applications may not have ViewModels, for e MVCVM applications or MVC applications that use ViewControllers, the following directory structure is recommended: - ./view/ - foo/ # Some meaningful grouping of one or more views - Foo.js # The view class - FooController.js # The controller for Foo (a ViewController) - FooModel.js # The ViewModel for Foo +```text +./view/ + foo/ # Some meaningful grouping of one or more views + Foo.js # The view class + FooController.js # The controller for Foo (a ViewController) + FooModel.js # The ViewModel for Foo +``` This structure helps keep these closely related classes together and easily identifiable in most tabbed IDE's or text editors. From 50776693094a7874a0f127cd46fba6f133f6e8c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8C=C3=A1bera?= Date: Fri, 18 May 2018 01:49:02 +0200 Subject: [PATCH 02/13] Bypass vscode and github markdown renderer diff --- README.md | 206 +++++++++++++++++++++++++++--------------------------- 1 file changed, 103 insertions(+), 103 deletions(-) diff --git a/README.md b/README.md index 293ac1c6..3014abbf 100644 --- a/README.md +++ b/README.md @@ -56,109 +56,109 @@ ## Services available - 98 -WhatsApp -Messenger -Skype -Slack -Hangouts -Telegram -WeChat -Gmail -Inbox -HipChat -Allo - -ChatWork -GroupMe -Grape -Gitter -Steam -Discord -Noysi -Outlook -Outlook 365 -TutaNota -Hushmail - -BearyChat -Aol -Sync -Wire -Rocket Chat -Missive -Yahoo! Mail -Ryver -Yandex Mail -Dasher -DingTalk - -FlowDock -Mattermost -Voxer -Glip -Yahoo! Messenger -mysms -ICQ -TweetDeck -Zinc -FreeNode -MightyText - -Zoho Email -Zoho Chat -Roundcube -Horde -SquirrelMail -Zimbra -Hootsuite -Amium -RainLoop -iCloud Mail -IRC Cloud - -Kiwi IRC -Smooch -Crisp -Flock -Openmailbox -Typetalk -Drift -Cisco Spark -Fleep -Socialcast -Riot - -Pushbullet -Movim -Kaiwa -Zyptonite -LinkedIn -The Lounge -Kezmo -Teams -Xing -Workplace -FastMail - -Hibox -Jandi -Threema -Messenger for Pages -VK Messenger -Mastodon -Teamwork Chat -ClockTweets -Intercom -Voice -Sandstorm - -Gadu-Gadu -Mail.Ru -Kune -Zulip -Stride -Hangouts Chat -Messenger for Business +WhatsApp +Messenger +Skype +Slack +Hangouts +Telegram +WeChat +Gmail +Inbox +HipChat +Allo + +ChatWork +GroupMe +Grape +Gitter +Steam +Discord +Noysi +Outlook +Outlook 365 +TutaNota +Hushmail + +BearyChat +Aol +Sync +Wire +Rocket Chat +Missive +Yahoo! Mail +Ryver +Yandex Mail +Dasher +DingTalk + +FlowDock +Mattermost +Voxer +Glip +Yahoo! Messenger +mysms +ICQ +TweetDeck +Zinc +FreeNode +MightyText + +Zoho Email +Zoho Chat +Roundcube +Horde +SquirrelMail +Zimbra +Hootsuite +Amium +RainLoop +iCloud Mail +IRC Cloud + +Kiwi IRC +Smooch +Crisp +Flock +Openmailbox +Typetalk +Drift +Cisco Spark +Fleep +Socialcast +Riot + +Pushbullet +Movim +Kaiwa +Zyptonite +LinkedIn +The Lounge +Kezmo +Teams +Xing +Workplace +FastMail + +Hibox +Jandi +Threema +Messenger for Pages +VK Messenger +Mastodon +Teamwork Chat +ClockTweets +Intercom +Voice +Sandstorm + +Gadu-Gadu +Mail.Ru +Kune +Zulip +Stride +Hangouts Chat +Messenger for Business ## Features From 40968e00ea133c4611d9b597ba288d96b51f344b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8C=C3=A1bera?= Date: Fri, 18 May 2018 01:50:21 +0200 Subject: [PATCH 03/13] Icons list --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 3014abbf..fc63fd9d 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,8 @@ Hangouts Chat Messenger for Business +--- + ## Features - [x] Multi-language. From 98ef4b0af23d50f57d5ddef2ff28ec51e9288cb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8C=C3=A1bera?= Date: Fri, 18 May 2018 01:51:03 +0200 Subject: [PATCH 04/13] Icons list --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fc63fd9d..778bf442 100644 --- a/README.md +++ b/README.md @@ -160,7 +160,7 @@ Hangouts Chat Messenger for Business ---- +









## Features From c4c9bd856c3c86763658383c92b9b4d675d9c7ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8C=C3=A1bera?= Date: Fri, 18 May 2018 01:51:55 +0200 Subject: [PATCH 05/13] Icon list --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 778bf442..a84b4384 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,7 @@ ## Services available - 98 +
WhatsApp Messenger Skype @@ -159,7 +160,7 @@ Stride Hangouts Chat Messenger for Business - +










## Features From a56cb94505a129fe8c70e18dd9eddf842b3ad0f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8C=C3=A1bera?= Date: Fri, 18 May 2018 01:53:42 +0200 Subject: [PATCH 06/13] Icon list --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a84b4384..53b8f7cb 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ ## Services available - 98 -
+
WhatsApp Messenger Skype From 6eb99a71d4fe98f3161fbcc60d85c9d3497a5032 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8C=C3=A1bera?= Date: Fri, 18 May 2018 01:55:09 +0200 Subject: [PATCH 07/13] Icon list --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 53b8f7cb..164da657 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,6 @@ ## Services available - 98 -
WhatsApp Messenger Skype @@ -160,8 +159,7 @@ Stride Hangouts Chat Messenger for Business -
-









+













## Features From 194f91722ecb74867c40f17d837c1522a886fc91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8C=C3=A1bera?= Date: Fri, 18 May 2018 01:55:38 +0200 Subject: [PATCH 08/13] Icon list --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 164da657..398a9256 100644 --- a/README.md +++ b/README.md @@ -159,7 +159,7 @@ Stride Hangouts Chat Messenger for Business -













+




















## Features From 68c8ff8414bd6a34c4fb45dba3f545ffb5b68b2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8C=C3=A1bera?= Date: Fri, 18 May 2018 01:56:11 +0200 Subject: [PATCH 09/13] Icon list --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 398a9256..a2fafc29 100644 --- a/README.md +++ b/README.md @@ -159,7 +159,8 @@ Stride Hangouts Chat Messenger for Business -




















+


























+




## Features From cd9c187ddfa81a68d8c419ac4a5c9f58ec994fcd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8C=C3=A1bera?= Date: Fri, 18 May 2018 02:04:11 +0200 Subject: [PATCH 10/13] Icon list --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index a2fafc29..ba458420 100644 --- a/README.md +++ b/README.md @@ -159,8 +159,7 @@ Stride Hangouts Chat Messenger for Business -


























-




+











































## Features From 0c50d3e0d3bb1a9b352a39ceaeb3908efb9bb562 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8C=C3=A1bera?= Date: Fri, 8 Jun 2018 19:14:41 +0200 Subject: [PATCH 11/13] Use direct links Add information about Slack community --- .github/CONTRIBUTING.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b714967a..117c2460 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -6,23 +6,17 @@ - Go to "Issues" and type any word in the top search/command bar. - Consider to search on closed issues. To do that just remove "is:open" from the search field. - More info on [search syntax within github](https://help.github.com/articles/searching-issues) -- Report the issue using our [template][template], it includes all the information we need to track down the issue. +- Report the issue using our [template](https://github.com/saenzramiro/rambox/blob/master/.github/ISSUE_TEMPLATE.md), it includes all the information we need to track down the issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. -[template]: https://github.com/saenzramiro/rambox/blob/master/.github/ISSUE_TEMPLATE.md - ## Share your Custom Services -If you consider there are other users that can use your Custom Service, we have a repo for this: [Rambox Services Contrib][rambox-services-contrib]. - -[rambox-services-contrib]: https://github.com/saenzramiro/rambox-services-contrib +If you consider there are other users that can use your Custom Service, we have a repo for this: [Rambox Services Contrib](https://github.com/saenzramiro/rambox-services-contrib) ## Ask for help -We have a great community in [Gitter][gitter] that can help you with any doubt or problem. - -[gitter]: https://gitter.im/saenzramiro/rambox +We have a great community in [Gitter](https://gitter.im/saenzramiro/rambox) (Gitter channel is mirroring into Slack general room) or [Slack](https://rambox.typeform.com/to/t7jc4C) that can help you with any doubt or problem. ## Contributing to Source Code @@ -30,6 +24,4 @@ Feel free to create pull requests to help us offer a great and complete software ## Translations -Please submit translations via [Crowdin][crowdin]. - -[crowdin]: https://crowdin.com/project/rambox/ +Please submit translations via [Crowdin](https://crowdin.com/project/rambox/). From 5dd1d11a279f665358ede407ed1e89af95685cb5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8C=C3=A1bera?= Date: Fri, 8 Jun 2018 19:57:34 +0200 Subject: [PATCH 12/13] Respec Uppercase for Readmes --- .github/CONTRIBUTING.md | 4 +- CONTRIBUTING.md | 20 +++----- app/Readme.md | 19 ++++---- app/model/Readme.md | 37 ++++++++------- .../ext-aria/build/resources/Readme.md | 2 +- ext/packages/ext-aria/resources/Readme.md | 2 +- ext/packages/ext-aria/sass/etc/Readme.md | 4 +- ext/packages/sencha-soap/Readme.md | 1 - packages/local/rambox-default-theme/Readme.md | 1 - .../rambox-default-theme/examples/Readme.md | 47 +++++++++++-------- .../local/rambox-default-theme/sass/Readme.md | 8 ++-- .../rambox-default-theme/sass/etc/Readme.md | 4 +- .../rambox-default-theme/sass/src/Readme.md | 4 +- .../local/rambox-default-theme/src/Readme.md | 3 +- resources/Readme.md | 4 -- sass/Readme.md | 35 ++++++-------- 16 files changed, 91 insertions(+), 104 deletions(-) delete mode 100644 resources/Readme.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 117c2460..cd116bee 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -5,7 +5,7 @@ - Please search the existing issues first, it's likely that your issue was already reported or even fixed. - Go to "Issues" and type any word in the top search/command bar. - Consider to search on closed issues. To do that just remove "is:open" from the search field. - - More info on [search syntax within github](https://help.github.com/articles/searching-issues) + - More info on [search syntax within github](https://help.github.com/articles/searching-issues). - Report the issue using our [template](https://github.com/saenzramiro/rambox/blob/master/.github/ISSUE_TEMPLATE.md), it includes all the information we need to track down the issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. @@ -16,7 +16,7 @@ If you consider there are other users that can use your Custom Service, we have ## Ask for help -We have a great community in [Gitter](https://gitter.im/saenzramiro/rambox) (Gitter channel is mirroring into Slack general room) or [Slack](https://rambox.typeform.com/to/t7jc4C) that can help you with any doubt or problem. +We have a great community in [Slack (Prefered)](https://rambox.typeform.com/to/t7jc4C) or [Gitter](https://gitter.im/saenzramiro/rambox) (Gitter channel is mirroring into Slack `general` room) that can help you with any doubt or problem. ## Contributing to Source Code diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ab6c88aa..b7090222 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ Working on your first Pull Request? You can learn how from this *free* series [H ##### If you've found a bug that is not on the board, [follow these steps](README.md#found-a-bug). --------------------------------------------------------------------------------- +--- ## Contribution Guidelines @@ -73,10 +73,7 @@ If your versions are lower than the prerequisite versions, you should update. 1. Open a Terminal / Command Line / Bash Shell in your projects directory (_i.e.: `/yourprojectdirectory/`_) 1. Clone your fork of rambox - -```shell -git clone https://github.com/yourUsername/rambox.git -``` + - `git clone https://github.com/yourUsername/rambox.git` **(make sure to replace `yourUsername` with your GitHub username)** @@ -86,12 +83,9 @@ This will download the entire rambox repo to your projects directory. 1. Change directory to the new rambox directory (`cd rambox`) 1. Add a remote to the official rambox repo: + - `git remote add upstream https://github.com/saenzramiro/rambox.git` -```shell -git remote add upstream https://github.com/saenzramiro/rambox.git -``` - -Congratulations, you now have a local copy of the rambox repo! +Congratulations, you now have a local copy of the rambox repo! :tada: ### Create a Branch @@ -164,9 +158,7 @@ Always feel free to reach out to the chat room when you are not certain of any t #### Adding or Editing Services The services are stored inside the file `./app/store/ServicesList.js`. Add your service to the *BOTTOM* of the array. - The logo it's referencing is located in `./resources/icons/`. - To see these changes you'll need to stop your `npm start` and `sencha app watch`, and then rerun those. ### Creating a Pull Request @@ -230,8 +222,8 @@ Don't despair! You should receive solid feedback as to why it was rejected and w Many Pull Requests, especially first Pull Requests, require correction or updating. If you have used the GitHub interface to create your PR, you will need to close your PR, create a new branch, and re-submit. -If you have a local copy of the repo, you can make the requested changes and amend your commit with: `git commit --amend` This will update your existing -commit. +If you have a local copy of the repo, you can make the requested changes and amend your commit with: `git commit --amend` +This will update your existing commit. When you push it to your fork you will need to do a force push to overwrite your old commit: `git push --force` Be sure to post in the PR conversation that you have made the requested changes. diff --git a/app/Readme.md b/app/Readme.md index 2b351cb2..5408688e 100644 --- a/app/Readme.md +++ b/app/Readme.md @@ -1,8 +1,8 @@ # ./controller -This folder contains the application's global controllers. ViewControllers are located -alongside their respective view class in `./view`. These controllers are used for routing -and other activities that span all views. +This folder contains the application's global controllers. +ViewControllers are located alongside their respective view class in `./view`. +These controllers are used for routing and other activities that span all views. # ./model @@ -10,10 +10,9 @@ This folder contains the application's (data) Model classes. # ./view -This folder contains the views as well as ViewModels and ViewControllers depending on the -application's architecture. Pure MVC applications may not have ViewModels, for example. For -MVCVM applications or MVC applications that use ViewControllers, the following directory -structure is recommended: +This folder contains the views as well as ViewModels and ViewControllers depending on the application's architecture. +Pure MVC applications may not have ViewModels, for example. +For MVCVM applications or MVC applications that use ViewControllers, the following directory structure is recommended: ```text ./view/ @@ -23,10 +22,8 @@ structure is recommended: FooModel.js # The ViewModel for Foo ``` -This structure helps keep these closely related classes together and easily identifiable in -most tabbed IDE's or text editors. +This structure helps keep these closely related classes together and easily identifiable in most tabbed IDE's or text editors. # ./store -This folder contains any number of store instances or types that can then be reused in the -application. +This folder contains any number of store instances or types that can then be reused in the application. diff --git a/app/model/Readme.md b/app/model/Readme.md index 14774c7a..2446be32 100644 --- a/app/model/Readme.md +++ b/app/model/Readme.md @@ -1,28 +1,29 @@ -## Adding a service +# Adding a service + +The available services are stored in the [ServicesList.js](../store/ServicesList.js). -The available services are stored in the [ServiceList.js](app/store/ServicesList.js). Structure of a service entry: -|Name|Description|Required| -|---|---|---| -|id|Unique identifier for the service, e.g. "slack"|yes| -|logo|File name of the service logo located in "/resources/icons/", e.g. "slack.png"|yes| -|name|Visible name for the service, e.g. "Slack"|yes| -|description|A short description of the service, e.g. "Slack brings all your communication together..."|yes| -|url|URL of the service, e.g. "https://\_\_\_.slack.com/". "\_\_\_" may be used as a placeholder, that can be configured when adding a service.|yes| -|type|Defines the type of the service. Must be one of `email` or `messaging`.|yes| -|allow_popups|Set to `true` to allow popup windows for the service.|no| -|note|Additional info to display when adding the service.|no| -|manual_notifications|Set to `true` to let Rambox trigger notifications. Can be used for services that doesn't support browser notifications.|no| -|js_unread|JavaScript code for setting the unread count (see below).|no| -|dont_update_unread_from_title|Set to `true` to prevent updating the unread count from the window title (see below).|no| +| Name | Description | Required | +| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| id | Unique identifier for the service, e.g. "**slack**" | yes | +| logo | File name of the service logo located in `/resources/icons/`, e.g. "**slack.png**" | yes | +| name | Visible name for the service, e.g. "**Slack**" | yes | +| description | A short description of the service, e.g. "**Slack brings all your communication together...**" | yes | +| url | URL of the service, e.g. "". "\_\_\_" may be used as a placeholder, that can be configured when adding a service. | yes | +| type | Defines the type of the service. Must be one of `email` or `messaging`. | yes | +| allow_popups | Set to `true` to allow popup windows for the service. | no | +| note | Additional info to display when adding the service. | no | +| manual_notifications | Set to `true` to let Rambox trigger notifications. Can be used for services that doesn't support browser notifications. | no | +| js_unread | JavaScript code for setting the unread count (see below). | no | +| dont_update_unread_from_title | Set to `true` to prevent updating the unread count from the window title (see below). | no | -### Setting the unread count +## Setting the unread count -While there is also a way to set the unread count by adding ` (COUNT)` to the window title, this describes the preferred way of doing it: +While there is also a way to set the unread count by adding `(COUNT)` to the window title, this describes the preferred way of doing it: First set `dont_update_unread_from_title` in the service config to `true`. Code provided by `js_unread` will be injected into the service website. You can retrieve the unread count in this JavaScript code e.g. by parsing elements. -Set the unread count by calling `rambox.setUnreadCount(COUNT)` or clear it by calling `rambox.clearUnreadCount()`. +Set the unread count by calling `rambox.setUnreadCount(COUNT)` or clear it by calling `rambox.clearUnreadCount()`. diff --git a/ext/packages/ext-aria/build/resources/Readme.md b/ext/packages/ext-aria/build/resources/Readme.md index 63245855..a181309b 100644 --- a/ext/packages/ext-aria/build/resources/Readme.md +++ b/ext/packages/ext-aria/build/resources/Readme.md @@ -1,3 +1,3 @@ # ext-aria/resources -This folder contains static resources (typically an `"images"` folder as well). +This folder contains static resources (typically an `images` folder as well). diff --git a/ext/packages/ext-aria/resources/Readme.md b/ext/packages/ext-aria/resources/Readme.md index 63245855..a181309b 100644 --- a/ext/packages/ext-aria/resources/Readme.md +++ b/ext/packages/ext-aria/resources/Readme.md @@ -1,3 +1,3 @@ # ext-aria/resources -This folder contains static resources (typically an `"images"` folder as well). +This folder contains static resources (typically an `images` folder as well). diff --git a/ext/packages/ext-aria/sass/etc/Readme.md b/ext/packages/ext-aria/sass/etc/Readme.md index 70692fe7..cd7b6a81 100644 --- a/ext/packages/ext-aria/sass/etc/Readme.md +++ b/ext/packages/ext-aria/sass/etc/Readme.md @@ -1,4 +1,4 @@ # ext-aria/sass/etc -This folder contains miscellaneous SASS files. Unlike `"ext-aria/sass/etc"`, these files -need to be used explicitly. +This folder contains miscellaneous SASS files. +Unlike `ext-aria/sass/etc`, these files need to be used explicitly. diff --git a/ext/packages/sencha-soap/Readme.md b/ext/packages/sencha-soap/Readme.md index e240dfb1..cf3feeba 100644 --- a/ext/packages/sencha-soap/Readme.md +++ b/ext/packages/sencha-soap/Readme.md @@ -1,2 +1 @@ # sencha-soap - Read Me - diff --git a/packages/local/rambox-default-theme/Readme.md b/packages/local/rambox-default-theme/Readme.md index 45788a59..43c435b1 100644 --- a/packages/local/rambox-default-theme/Readme.md +++ b/packages/local/rambox-default-theme/Readme.md @@ -1,2 +1 @@ # rambox-default-theme - Read Me - diff --git a/packages/local/rambox-default-theme/examples/Readme.md b/packages/local/rambox-default-theme/examples/Readme.md index 3aa34750..9de4d6b7 100644 --- a/packages/local/rambox-default-theme/examples/Readme.md +++ b/packages/local/rambox-default-theme/examples/Readme.md @@ -1,38 +1,45 @@ # rambox-default-theme/examples -This folder contains example applications demonstrating this package. Each of -these applications will be built as part of the package build: +This folder contains example applications demonstrating this package. +Each of these applications will be built as part of the package build: - cd /path/to/package - sencha package build +```bash +cd /path/to/package +sencha package build +``` As applications, they can also be built individually: - cd /path/to/package/examples/example-app - sencha app build +```bash +cd /path/to/package/examples/example-app +sencha app build +``` Or you can build all examples as a group: - cd /path/to/package - sencha ant examples +```bash +cd /path/to/package +sencha ant examples +``` The ideal location for the example builds to reside is the `"./build"` folder: - /path/to/package/ - src/ - resources/ +```text +/path/to/package/ + src/ + resources/ + ... + examples/ + example-app/ + other-example/ ... + build/ + resources/ examples/ example-app/ other-example/ - ... - build/ - resources/ - examples/ - example-app/ - other-example/ +``` -This can be specified in the `".sencha/app/build.properties"` file for the -example applications: +This can be specified in the `".sencha/app/build.properties"` file for the example applications: - build.dir=${package.build.dir}/examples/${app.name} +`build.dir=${package.build.dir}/examples/${app.name}` diff --git a/packages/local/rambox-default-theme/sass/Readme.md b/packages/local/rambox-default-theme/sass/Readme.md index 9a65b067..a8e3aa6a 100644 --- a/packages/local/rambox-default-theme/sass/Readme.md +++ b/packages/local/rambox-default-theme/sass/Readme.md @@ -2,6 +2,8 @@ This folder contains SASS files of various kinds, organized in sub-folders: - rambox-default-theme/sass/etc - rambox-default-theme/sass/src - rambox-default-theme/sass/var +```text +rambox-default-theme/sass/etc +rambox-default-theme/sass/src +rambox-default-theme/sass/var +``` diff --git a/packages/local/rambox-default-theme/sass/etc/Readme.md b/packages/local/rambox-default-theme/sass/etc/Readme.md index d7030ab0..0e1db734 100644 --- a/packages/local/rambox-default-theme/sass/etc/Readme.md +++ b/packages/local/rambox-default-theme/sass/etc/Readme.md @@ -1,4 +1,4 @@ # rambox-default-theme/sass/etc -This folder contains miscellaneous SASS files. Unlike `"rambox-default-theme/sass/etc"`, these files -need to be used explicitly. +This folder contains miscellaneous SASS files. +Unlike `"rambox-default-theme/sass/etc"`, these files need to be used explicitly. diff --git a/packages/local/rambox-default-theme/sass/src/Readme.md b/packages/local/rambox-default-theme/sass/src/Readme.md index 55c711a6..ca4b918a 100644 --- a/packages/local/rambox-default-theme/sass/src/Readme.md +++ b/packages/local/rambox-default-theme/sass/src/Readme.md @@ -1,4 +1,4 @@ # rambox-default-theme/sass/src -This folder contains SASS sources that mimic the component-class hierarchy. These files -are gathered in to a build of the CSS based on classes that are used by the build. +This folder contains SASS sources that mimic the component-class hierarchy. +These files are gathered in to a build of the CSS based on classes that are used by the build. diff --git a/packages/local/rambox-default-theme/src/Readme.md b/packages/local/rambox-default-theme/src/Readme.md index b8828534..93c4caa1 100644 --- a/packages/local/rambox-default-theme/src/Readme.md +++ b/packages/local/rambox-default-theme/src/Readme.md @@ -1,4 +1,3 @@ # rambox-default-theme/src -This folder contains source code that will automatically be added to the classpath when -the package is used. +This folder contains source code that will automatically be added to the classpath when the package is used. diff --git a/resources/Readme.md b/resources/Readme.md deleted file mode 100644 index dc0d331d..00000000 --- a/resources/Readme.md +++ /dev/null @@ -1,4 +0,0 @@ -# Rambox/resources - -This folder contains resources (such as images) needed by the application. This file can -be removed if not needed. diff --git a/sass/Readme.md b/sass/Readme.md index f9be38f9..d10acdbc 100644 --- a/sass/Readme.md +++ b/sass/Readme.md @@ -4,41 +4,36 @@ This folder contains the styling for the application's views. The primary pi ## Styling -Sencha Cmd supports styling using Sass and integrates the styling from the theme -and required packages (specified in `"app.json"`) with application-defined views. +Sencha Cmd supports styling using Sass and integrates the styling from the theme and required packages (specified in `app.json`) with application-defined views. ### ./sass/etc -This folder contains misc. support code for Sass builds (global functions, -mixins, etc.). +This folder contains misc. support code for Sass builds (global functions, mixins, etc.). ### ./sass/src This folder contains Sass files defining CSS rules corresponding to classes -included in the application's JavaScript code build. By default, files in this +included in the application's JavaScript code build. By default, files in this folder are mapped to the application's root namespace, 'Rambox'. This is set in -`"app.json"`: +`app.json`: - "sass": { - "namespace": "Rambox" - } +```json +"sass": { + "namespace": "Rambox" +} +``` ### ./sass/var -This folder contains Sass files defining Sass variables corresponding to classes -included in the application's JavaScript code build. By default, files in this -folder are mapped to the application's root namespace, 'Rambox' in the same way -as `"Rambox/sass/src"`. +This folder contains Sass files defining Sass variables corresponding to classes included in the application's JavaScript code build. +By default, files in this folder are mapped to the application's root namespace, 'Rambox' in the same way as `Rambox/sass/src`. ## Slicing -Internet Explorer 8 and 9 do not support linear gradients and IE8 does not support -border-radius. To compensate for this, Sencha Cmd provides "image slicing" using an -internal WebKit based renderer. To enable this, there is a special web page that -renders all components and states so they can be captured and turned into image -sprites. +Internet Explorer 8 and 9 do not support linear gradients and IE8 does not support border-radius. +To compensate for this, Sencha Cmd provides "image slicing" using an internal WebKit based renderer. +To enable this, there is a special web page that renders all components and states so they can be captured and turned into image sprites. ### ./sass/example -This folder contains the web page used to present all components and states so they -can be captured as an image and used to produce images for IE8 and 9. +This folder contains the web page used to present all components and states so they can be captured as an image and used to produce images for IE8 and 9. From ccfc303316c8ae9c9bd11c43f14da067d2f699ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C4=8C=C3=A1bera?= Date: Fri, 8 Jun 2018 20:12:13 +0200 Subject: [PATCH 13/13] Respec uppercase for READMEs --- app/{Readme.md => README.md} | 0 app/model/{Readme.md => README.md} | 0 app/store/{Readme.md => README.md} | 0 sass/{Readme.md => README.md} | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename app/{Readme.md => README.md} (100%) rename app/model/{Readme.md => README.md} (100%) rename app/store/{Readme.md => README.md} (100%) rename sass/{Readme.md => README.md} (100%) diff --git a/app/Readme.md b/app/README.md similarity index 100% rename from app/Readme.md rename to app/README.md diff --git a/app/model/Readme.md b/app/model/README.md similarity index 100% rename from app/model/Readme.md rename to app/model/README.md diff --git a/app/store/Readme.md b/app/store/README.md similarity index 100% rename from app/store/Readme.md rename to app/store/README.md diff --git a/sass/Readme.md b/sass/README.md similarity index 100% rename from sass/Readme.md rename to sass/README.md