jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

nimsuggest: update documentation

Browse source
This commit is contained in:
Araq 2017-03-08 12:44:57 +01:00
commit 23a303c536
1 changed files with 7 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

21
doc/nimsuggest.rst
View file

@ -25,26 +25,19 @@ already available.
Installation Installation
============ ============
Nimsuggest is available as a Nimble package but currently does not install Nimsuggest is part of Nim's core. Build it via::
properly via Nimble. As nimsuggest is part of the compiler it also doesn't make
too much sense as a Nimble package. Instead we will do the building manually::
cd compiler/nimsuggest
nim c -d:release nimsuggest
cp nimsuggest ../../bin
# OR: copy the nimsuggest binary to where your 'nim' binary is
cd ../..
koch nimsuggest
Nimsuggest invocation Nimsuggest invocation
===================== =====================
Run it via ``nimsuggest --stdin myproject.nim``. Nimsuggest is a server that Run it via ``nimsuggest --stdin --debug --v2 myproject.nim``. Nimsuggest is a
takes queries that are related to ``myproject``. There is some support so that server that takes queries that are related to ``myproject``. There is some
you can throw random ``.nim`` files which are not part of ``myproject`` at support so that you can throw random ``.nim`` files which are not part
Nimsuggest too, but usually the query refer to modules/files that are part of of ``myproject`` at Nimsuggest too, but usually the query refer to modules/files
``myproject``. that are part of ``myproject``.
``--stdin`` means that Nimsuggest reads the query from ``stdin``. This is great ``--stdin`` means that Nimsuggest reads the query from ``stdin``. This is great
for testing things out and playing with it but for an editor communication for testing things out and playing with it but for an editor communication