Commit 884b19d5 authored by Christian Hergert's avatar Christian Hergert
Browse files

README: migrate readme to markdown

parent fa0b5ddb
Builder - Develop software for GNOME
====================================
Bugs: https://bugzilla.gnome.org/enter_bug.cgi?product=gnome-builder
Download: https://download.gnome.org/sources/gnome-builder/
Git: https://git.gnome.org/browse/gnome-builder
Website: https://wiki.gnome.org/Apps/Builder
IRC: irc.gimp.net #gnome-builder
----
Builder attempts to be an IDE for writing software for GNOME. It does not try
to be a generic IDE, but one specialized for writing GNOME software. We believe
that this focus will help us to build something great.
If you would like to help in this effort, join our IRC channel and we will help
you find something to work on.
Builder is written in C, but some aspects of Builder may be written in another
language if it makes sense.
----
Builder is developed in conjunction with GNOME releases. This means that we
often contribute to, and depend on, features being developed in other GNOME
modules.
----
Builder is built using meson:
meson _build --prefix=/usr
ninja -C _build
sudo ninja -C _build install
----
Alternatively, you can build Builder from git using jhbuild. If you are
unfamiliar with jhbuild, the following will help you get started.
git clone git://git.gnome.org/jhbuild.git
cd jhbuild
./autogen.sh --simple-install
make
make install
jhbuild build gnome-builder
jhbuild run gnome-builder
If you have problems building or running Builder, please contact us on IRC
(link is at the top of this file) and we will help you out.
----
Builder is licensed under the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your option)
any later version. Some files are individually licensed under alternative
licenses such as LGPL-2.1+ and LGPL-3.0.
# Builder
Develop software for GNOME
## Helpful Links
* [Read the documentation](http://builder.readthedocs.io/en/latest/)
* [File a Bug on Bugzilla](https://bugzilla.gnome.org/enter_bug.cgi?product=gnome-builder)
* [Download a Release Tarball](https://download.gnome.org/sources/gnome-builder/)
* [Browse source code in Git version control](https://git.gnome.org/browse/gnome-builder)
* [Learn more about Builder](https://wiki.gnome.org/Apps/Builder)
* [Chat with the developers](irc://irc.gnome.org/#gnome-builder)
----
Builder aims to be an IDE for writing GNOME-based software.
We believe this focus will help us build something great for our community.
If you would like to help in this effort, join our IRC channel and we will help you find something to work on.
Builder is primarily written in C and Python.
Some aspects of Builder may be written in another language when it makes sense.
Builder is developed in conjunction with GNOME releases.
This means that we often contribute to, and rely on, features being developed in other GNOME modules such as Gtk.
----
Builder is built using meson:
```sh
meson --prefix=/usr build
ninja -C build
sudo ninja -C build install
```
For more information on building and installing Builder,
[read our installation guide](http://builder.readthedocs.io/en/latest/installation.html)
to help you through the process.
----
Builder is licensed under the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your option)
any later version. Some files are individually licensed under alternative
licenses such as LGPL-2.1+ and LGPL-3.0.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment