Giter VIP home page Giter VIP logo

atomic-rtags's Introduction

Atomic rtags

A package for the atom editor that provides excellent C++ code navigation functionality using rtags.

rtags in action

(Click through for full YouTube video)

Quickstart

First, download and install rtags. This unfortunately takes a really long time:

$ brew install rtags

Then, use it to index your project: for CMake-based projects,

$ git clone https://github.com/taglib/taglib # replace with your project
$ mkdir taglib-build
$ cd taglib-build
$ cmake -GNinja ../taglib
$ rdm # in another terminal
$ ninja -t commands | rc -c -

Next, install atomic-rtags through Atom, and check the configuration options. Open your .cpp file, and hit alt+, with the cursor positioned at the symbol you want to look up.

Troubleshooting

Not indexed: Index your project by piping the build commands to rc -c -.

(Jumps to incorrect location): Open an issue.

Not found or Indexing in progress: Inspect the output of rc -f <filename>:<line>:<column> (after starting rdm). Some symbols are genuinely not indexed by rtags though.

Can't seem to connect to server: Start rdm, or enable rdmAutoSpawn, under configuration options.

Other error: Open an issue.

Why not YCM?

YouCompleteMe is a popular choice for the task; however, rtags beats ycm in practice: ycm is slow, confusing, hard to configure, and complains about not being able to look up definitions often.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.