Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Readme updated theme and format #326

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Readme updated theme and format #326

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0cf496f
Update README.md with new theme and format
JaydenDownes Jul 16, 2024
79a30cb
Update README.md
JaydenDownes Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
157 changes: 65 additions & 92 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,127 +1,100 @@
Welcome to Brackets! [![Build Status](https://travis-ci.org/adobe/brackets.svg?branch=master)](https://travis-ci.org/adobe/brackets)
-------------------

Brackets is a modern open-source code editor for HTML, CSS
and JavaScript that's *built* in HTML, CSS and JavaScript.
<p align="center">
<a>
<img alt="Brackets" title="Brackets Code Editor" src="https://i.imgur.com/eZgX0NM.png" width="350">
</a>
</p>

This is a fork of a [project](https://github.com/adobe/brackets) previously maintained by Adobe.
We might change names in the future.
<p align="center">
Brackets is a modern open-source code editor for HTML, CSS and JavaScript that's <b>built</b> in HTML, CSS and JavaScript.
</p>

A lot of work needs to be done to make this fork become independent. Feel free to open a PR!
Want to help coordinating the project itself? Check the projects tab ([here](https://github.com/brackets-cont/brackets/projects/1?fullscreen=true)).
<h3 align="center">
<a href="https://github.com/brackets-cont/brackets/releases">
<img src="https://i.imgur.com/desezDh.png" alt="Releases" height="75px">
</a>
<a href="https://github.com/brackets-cont/brackets#helping-brackets">
<img src="https://i.imgur.com/HoJEaG3.png" alt="Contribute" height="75px">
</a>
<a href="https://brackets.io/">
<img src="https://i.imgur.com/MfNBdz2.png" alt="Website" height="75px">
</a>
</h3>

What makes Brackets different from other web code editors?
<br/>

* **Tools shouldn't get in your way.** Instead of cluttering up your coding
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
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/brackets-cont/brackets/blob/master/CONTRIBUTING.md) the best code editor for the web.
### About Brackets

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.
This project is a fork of an earlier version maintained by Adobe, with potential future name changes in store.
We welcome contributions to help this fork achieve independence—feel free to submit a PR! For coordinating efforts, please visit our [Projects tab](https://github.com/brackets-cont/brackets/projects/1?fullscreen=true).
<br><br>

You can see some
[screenshots of Brackets](https://github.com/brackets-cont/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/).
### What sets Brackets apart?

How to install and run Brackets
-------------------------------
#### Download
- **Minimalist Approach:** Brackets' Quick Edit UI keeps your coding environment clean by integrating context-specific code and tools inline, rather than cluttering it with panels and icons.

- **Live Preview:** Stay in sync with your browser. Brackets works directly with your browser to instantly push code edits and switch seamlessly between your source code and browser view.

- **Open Source Customization:** Built with HTML, CSS, and JavaScript, Brackets invites you to contribute to crafting the best web code editor. Learn more about how you can [get involved](https://github.com/brackets-cont/brackets/blob/master/CONTRIBUTING.md).

Brackets has hit version 1, but our journey continues with exciting feature ideas and innovative workflows for web development. Explore Brackets through [screenshots](https://github.com/brackets-cont/brackets/wiki/Brackets-Screenshots), [intro videos](http://www.youtube.com/user/CodeBrackets), and updates on the [Brackets blog](http://blog.brackets.io/).
<br><br>

Installers for the latest stable build for Mac and Windows can be [downloaded here](https://brackets-cont.github.io/).
### Installation and Usage

#### Usage
#### Download

By default, Brackets opens a folder containing some simple "Getting Started" content.
You can choose a different folder to edit using *File > Open Folder*.
Get the latest stable builds for Mac and Windows from our [downloads page](https://brackets-cont.github.io/).

Most of Brackets should be pretty self-explanatory, but for information on how
to use its unique features, like Quick Edit and Live Preview, please read
[How to Use Brackets](http://github.com/brackets-cont/brackets/wiki/How-to-Use-Brackets).
Also, see the [release notes](http://github.com/brackets-cont/brackets/wiki/Release-Notes)
for a list of new features and known issues in each build.
#### Getting Started

In addition to the core features built into Brackets, there is a large and growing
community of developers building extensions that add all sorts of useful functionality.
See the [Brackets Extension Registry](https://registry.brackets.io/)
for a list of available extensions. For installation instructions,
see the [extensions wiki page](https://github.com/brackets-cont/brackets/wiki/Brackets-Extensions).
Upon opening Brackets, you'll find simple "Getting Started" content. To edit a different folder, use `File > Open Folder`.

#### Need help?
While most features are intuitive, explore unique functionalities like Quick Edit and Live Preview through our [usage guide](http://github.com/brackets-cont/brackets/wiki/How-to-Use-Brackets). Stay informed with each build's [release notes](http://github.com/brackets-cont/brackets/wiki/Release-Notes).
<br><br>

Having problems starting Brackets the first time, or not sure how to use Brackets? Please
review [Troubleshooting](https://github.com/brackets-cont/brackets/wiki/Troubleshooting), which helps
you to fix common problems and find extra help if needed.
### Extending Brackets

Helping Brackets
----------------
Beyond core features, a vibrant community creates extensions for additional functionalities. Discover these extensions on the [Brackets Extension Registry](https://registry.brackets.io/). Installation instructions are available on the [extensions wiki page](https://github.com/brackets-cont/brackets/wiki/Brackets-Extensions).
<br><br>

#### I found a bug!
### Need Help?

If you found a repeatable bug, and [troubleshooting](https://github.com/brackets-cont/brackets/wiki/Troubleshooting)
tips didn't help, then be sure to [search existing issues](https://github.com/brackets-cont/brackets/issues) first.
Include steps to consistently reproduce the problem, actual vs. expected results, screenshots, and your OS 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/brackets-cont/brackets/wiki/How-to-Report-an-Issue)
Encountering issues starting or using Brackets? Consult our [Troubleshooting guide](https://github.com/brackets-cont/brackets/wiki/Troubleshooting) for solutions and additional support options.
<br><br>

### Contributing to Brackets

#### I have a new suggestion, but don't know how to program!
#### Reporting Issues

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
move it to the feature backlog for you.
If you discover a bug, check existing [issues](https://github.com/brackets-cont/brackets/issues) and include detailed steps, screenshots, and system information when reporting. Ensure extensions are disabled to confirm it's a core Brackets issue.

#### Feature Requests

#### I want to help with the code!
For new feature suggestions, check our [Trello board](http://bit.ly/BracketsBacklog) and file a feature request if it's not listed.

Awesome! _There are lots of ways you can help._ First read
[CONTRIBUTING.md](https://github.com/brackets-cont/brackets/blob/master/CONTRIBUTING.md),
then learn how to [pull the repo and hack on Brackets](https://github.com/brackets-cont/brackets/wiki/How-to-Hack-on-Brackets).
#### Contributing Code

The text editor inside Brackets is based on
[CodeMirror](http://github.com/codemirror/CodeMirror)&mdash;thanks to Marijn for
taking our pull requests, implementing feature requests and fixing bugs! See
[Notes on CodeMirror](https://github.com/brackets-cont/brackets/wiki/Notes-on-CodeMirror)
for info on how we're using CodeMirror.
Excited to contribute? Start with our [CONTRIBUTING.md](https://github.com/brackets-cont/brackets/blob/master/CONTRIBUTING.md) guide and learn how to hack on Brackets [here](https://github.com/brackets-cont/brackets/wiki/How-to-Hack-on-Brackets).
<br><br>

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.)
The native shell for Brackets lives in a separate repo,
[brackets-cont/brackets-shell](https://github.com/brackets-cont/brackets-shell/).
### Acknowledgments

The text editor inside Brackets uses [CodeMirror](http://github.com/codemirror/CodeMirror), thanks to Marijn for supporting our enhancements and bug fixes.

I want to keep track of how Brackets is doing!
----------------------------------------------
Brackets operates as a desktop application within a native shell, enabling access to local files. Learn more about our native shell at [brackets-cont/brackets-shell](https://github.com/brackets-cont/brackets-shell/).
<br><br>

Not sure you needed the exclamation point there, but we like your enthusiasm.
### Stay Connected

#### What's Brackets working on next?
Track Brackets' progress through:

* 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.
* Watch our [GitHub activity stream](https://github.com/brackets-cont/brackets/pulse).
* The entire development process is outlined in the [Developer Guide](https://github.com/brackets-cont/brackets/wiki/Brackets-Developers-Guide).
- [Feature backlog](http://bit.ly/BracketsBacklog)
- [GitHub activity](https://github.com/brackets-cont/brackets/pulse)
- [Developer Guide](https://github.com/brackets-cont/brackets/wiki/Brackets-Developers-Guide)

#### Contact info
For further inquiries, connect with us via [Matrix](https://matrix.to/#/#brackets-cont:matrix.org), [Discord](https://discord.gg/rBpTBPttca), or [Reddit](https://www.reddit.com/r/brackets/).

<!-- * **E-mail:** [[email protected]](mailto:[email protected])
* **Slack:** [Brackets on Slack](https://brackets.slack.com) (You can join by sending a mail to [[email protected]](mailto:[email protected]) with the subject line `slack registration request` specifying the email addresses you would like to register).
* **Developers mailing list:** http://groups.google.com/group/brackets-dev
* **Twitter:** [@brackets](https://twitter.com/brackets)
* **Blog:** http://blog.brackets.io/
* **IRC:** [#brackets on freenode](http://webchat.freenode.net/?channels=brackets)
-->
* **Matrix:** [@brackets-cont:matrix.org](https://matrix.to/#/#brackets-cont:matrix.org)
* **Discord:** [Brackets Discord Server](https://discord.gg/rBpTBPttca)
* **Reddit:** [r/Brackets](https://www.reddit.com/r/brackets/)
---

Please note that this project is released with a [Contributor Code of Conduct](https://github.com/brackets-cont/brackets/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
This project is governed by a [Contributor Code of Conduct](https://github.com/brackets-cont/brackets/blob/master/CODE_OF_CONDUCT.md). By participating, you agree to abide by its terms.