Skip to content

Commit 03d3bf0

Browse files
committed
add getting started and more details on community packages
1 parent 4603d75 commit 03d3bf0

File tree

2 files changed

+37
-2
lines changed

2 files changed

+37
-2
lines changed

assets/images/screenshot-sig-help.png

222 KB
Loading

index.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,49 @@
44

55
layout: default
66
---
7+
## Objective
78

89
The original objective of the Facebook [Nuclide](https://nuclide.io) / [Atom-IDE](https://ide.atom.io) project has been to provide extension packages for the [Atom Editor](https://www.atom.io) to interact with custom Language Servers via the [Language Server Protocol](https://langserver.org) to enable IDE like functionality in our beloved editor.
910

1011
The original package was made of various "subpackages" that provide the overall functionality and were always build and released in a monolithic extension (aka atom-ide-ui).
1112

1213
The objective of this project is to take over the concepts and ideas in the original atom-ide-ui package, but provide individual extensions that can be developed, released and installed independently.
1314

14-
We will start with the most important features, and iterate on them quickly to come on par with the functionality available in the atom-ide-ui package.
15+
We will start with the most important features, and iterate on them quickly to come on par with the functionality available in the atom-ide-ui package.
16+
17+
18+
## Getting Started
19+
20+
So far, there have been a few features from the original atom-ide-ui package that have been created as individual packages. Here are the steps required to start using IDE features in your Atom Text Editor using the new community packages.
21+
22+
1. Install an IDE language package that you would like to use:
23+
* TypeScript & JavaScript [ide-typescript](https://atom.io/packages/ide-typescript)
24+
* Python [ide-python](https://atom.io/packages/ide-python)
25+
* Rust [ide-rust](hhttps://atom.io/packages/ide-rust)
26+
* You can also search for [packages](https://atom.io/packages/search?q=IDE) in Atom.
27+
28+
2. Install any of the [community packages](https://atom.io/users/atom-ide-community) listed below.
29+
30+
3. Enjoy!
31+
32+
## Atom IDE Community Packages
33+
34+
### AutoComplete
35+
36+
Once you have installed an IDE language package, this should work right away.
37+
38+
### [Data Tip](https://atom.io/packages/atom-ide-datatip)
39+
40+
A replacement of the DataTip functionality from atom-ide-ui. When you hover over a symbol in your code (or move your cursor to it), it can show you details about that symbol in a tool tip. [More details](https://github.com/atom-ide-community/atom-ide-datatip#atom-ide-datatip-package)
1541

16-
Data Tip Provider
1742
![](./assets/images/screenshot-datatip.png){:width="100%"}
43+
44+
### [Signature Help](https://atom.io/packages/atom-ide-signature-help)
45+
46+
A replacement of the signature help functionality from atom-ide-ui. When you're calling a function, it can help you understand the parameters or information about the function you’re calling. [More details](https://github.com/atom-ide-community/atom-ide-signature-help#atom-ide-signature-help)
47+
48+
![](./assets/images/screenshot-sig-help.png){:width="100%"}
49+
50+
### [Go to Definition](https://atom.io/packages/atom-ide-definitions)
51+
52+
A replacement of the go to definition functionality from atom-ide-ui. [More details](https://github.com/atom-ide-community/atom-ide-definitions#atom-ide-definitions-package)

0 commit comments

Comments
 (0)