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

List required development headers in README #3272

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

List required development headers in README #3272

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 37 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,42 @@ code from GitHub.

## How to build and install ##

To build with Autotools (Autoconf, Automake, and Libtool) on GNU/Linux, OSX, or Windows 10 WSL,
```
$ git clone https://github.com/universal-ctags/ctags.git
$ cd ctags
$ ./autogen.sh
$ ./configure --prefix=/where/you/want # defaults to /usr/local
$ make
$ make install # may require extra privileges depending on where to install
```
To build with Autotools (Autoconf, Automake, and Libtool) on GNU/Linux, OSX, or Windows 10 WSL:

1. Clone the repository and run `./autogen.sh`:

```
$ git clone https://github.com/universal-ctags/ctags.git
$ cd ctags
$ ./autogen.sh
```
2. Install development headers for the following **[prerequisite|useful|delete as appropriate]** libraries. These
provide **[essential|useful|delete as appropriate]** functionality for Universal Ctags as follows:

- [Libxml2][libxml]: This allows Universal Ctags to **[fill in appropriate functionality]**.
- [Jansson][jansson]: This allows Universal Ctags to **[fill in appropriate functionality]**.
- [LibYAML][libyaml]: This allows Universal Ctags to **[fill in appropriate functionality]**.
- [PCRE2][pcre2]: This allows Universal Ctags to **[fill in appropriate functionality]**.

On Debian-based Linux distributions, these can be installed with

```
$ sudo apt-get install libxml2-dev libpcre2-dev libyaml-dev libjansson-dev
```


[libxml]: http://xmlsoft.org
[jansson]: https://github.com/akheron/jansson
[libyaml]: https://github.com/yaml/libyaml
[pcre2]: https://www.pcre.org

3. Configure, build and install the Universal Ctags executable:

```
$ ./configure --prefix=/where/you/want # defaults to /usr/local
$ make
$ make install # may require extra privileges depending on where to install
```

See
[`docs/autotools.rst`](https://github.com/universal-ctags/ctags/blob/master/docs/autotools.rst)
Expand Down Expand Up @@ -121,3 +148,4 @@ The most significant incompatible changes:
is appreciated.

Pull-requests are welcome!

Loading