diff --git a/README.md b/README.md index 481d454ef3f..b910f8fda99 100644 --- a/README.md +++ b/README.md @@ -10,17 +10,16 @@ What makes Brackets different from other web code editors? environment with lots of panels and icons, the Quick Edit UI in Brackets puts context-specific code and tools inline. * **Brackets is in sync with your browser.** With Live Preview, Brackets -works directly with your browser to push code edits instantly and jump +works directly with your browser to push code edits instantly. It also jumps back and forth between your real source code and the browser view. -* **Do it yourself.** Because Brackets is open source, and built with HTML, CSS -and JavaScript, you can [help build](https://github.com/adobe/brackets/blob/master/CONTRIBUTING.md) the best code editor for the web. +* **Do it yourself.** Because Brackets is open-source which is built on HTML, CSS +and JavaScript, you are welcomed to [build](https://github.com/adobe/brackets/blob/master/CONTRIBUTING.md) the best code editor for the web. -Brackets may have reached version 1, but we're not stopping there. We have many feature ideas on our -[trello board](http://bit.ly/BracketsTrelloBoard) that we're anxious to add and other -innovative web development workflows that we're planning to build into Brackets. -So take Brackets out for a spin and let us know how we can make it your favorite editor. +Brackets have completed first version, but we are not stopping there. We come up with many feature ideas on our +[trello board](http://bit.ly/BracketsTrelloBoard) that we are eager to add. We are planning to build other innovative web development workflows into Brackets. +Therefore, you are endorsed to take Brackets out for a spin and let us know how we can make it your favorite editor. -You can see some +You can see [screenshots of Brackets](https://github.com/adobe/brackets/wiki/Brackets-Screenshots) on the wiki, [intro videos](http://www.youtube.com/user/CodeBrackets) on YouTube, and news on the [Brackets blog](http://blog.brackets.io/). @@ -28,17 +27,17 @@ How to install and run Brackets ------------------------------- #### Download -Installers for the latest stable build for Mac, Windows and Linux (Debian/Ubuntu) can be [downloaded here](http://brackets.io/). +To install the latest stable version on Mac, Windows and Linux (Debian/Ubuntu) can be [found here](http://brackets.io/). #### Usage -By default, Brackets opens a folder containing some simple "Getting Started" content. -You can choose a different folder to edit using *File > Open Folder*. +Brackets automatically opens a folder containing simple "Getting Started" content. +You are able to choose a different folder to edit using *File > Open Folder*. -Most of Brackets should be pretty self-explanatory, but for information on how +Brackets is self-explanatory, but the information on how to use its unique features, like Quick Edit and Live Preview, please read [How to Use Brackets](http://github.com/adobe/brackets/wiki/How-to-Use-Brackets). -Also, see the [release notes](http://github.com/adobe/brackets/wiki/Release-Notes) +See the [release notes](http://github.com/adobe/brackets/wiki/Release-Notes) for a list of new features and known issues in each build. In addition to the core features built into Brackets, there is a large and growing @@ -49,7 +48,7 @@ see the [extensions wiki page](https://github.com/adobe/brackets/wiki/Brackets-E #### Need help? -Having problems starting Brackets the first time, or not sure how to use Brackets? Please +Having problems starting Brackets for the first time, or not sure how to use Brackets? Please review [Troubleshooting](https://github.com/adobe/brackets/wiki/Troubleshooting), which helps you to fix common problems and find extra help if needed. @@ -58,9 +57,9 @@ Helping Brackets #### I found a bug! -If you found a repeatable bug, and [troubleshooting](https://github.com/adobe/brackets/wiki/Troubleshooting) -tips didn't help, then be sure to [search existing issues](https://github.com/adobe/brackets/issues) first. -Include steps to consistently reproduce the problem, actual vs. expected results, screenshots, and your OS and +If you find a repeatable bug, and [troubleshooting](https://github.com/adobe/brackets/wiki/Troubleshooting) +tips do not help, then be sure to [search existing issues](https://github.com/adobe/brackets/issues) first. +Include steps to consistently reproduce the problem, actual vs. expected results, screenshots, your Oerating System and Brackets version number. Disable all extensions to verify the issue is a core Brackets bug. [Read more guidelines for filing good bugs.](https://github.com/adobe/brackets/wiki/How-to-Report-an-Issue) @@ -68,7 +67,7 @@ Brackets version number. Disable all extensions to verify the issue is a core Br #### I have a new suggestion, but don't know how to program! For feature requests please first check our [Trello board](http://bit.ly/BracketsBacklog) to -see if it's already there; you can upvote it if so. If not, feel free to file it as an issue as above; we'll +see if it is already there; you can upvote it if so. If not, feel free to file it as an issue as above; we'll move it to the feature backlog for you. @@ -85,8 +84,8 @@ taking our pull requests, implementing feature requests and fixing bugs! See for info on how we're using CodeMirror. Although Brackets is built in HTML/CSS/JS, it currently runs as a desktop -application in a thin native shell, so that it can access your local files. -(If you just try to open the index.html file in a browser, it won't work yet.) +application in a thin native shell, so that it accesses your local files. +(If you just try to open the index.html file in a browser, it w will not work.) The native shell for Brackets lives in a separate repo, [adobe/brackets-shell](https://github.com/adobe/brackets-shell/). @@ -99,8 +98,8 @@ Not sure you needed the exclamation point there, but we like your enthusiasm. #### What's Brackets working on next? * In our [feature backlog](http://bit.ly/BracketsBacklog), the columns to the right - (starting from "Development") list the features that we're currently working on. - "Ready" shows what we'll be working on next. + (starting from "Development") are list of the features that we are currently working on. + "Ready" shows what we will be working on next. * Watch our [GitHub activity stream](https://github.com/adobe/brackets/pulse). * Watch our [Waffle Kanban board](https://waffle.io/adobe/brackets): Work items in [![Stories in Ready](https://badge.waffle.io/adobe/brackets.svg?label=ready&title=Ready)](http://waffle.io/adobe/brackets) are next. The entire development process is outlined in the [Developer Guide](https://github.com/adobe/brackets/wiki/Brackets-Developers-Guide).