summary refs log blame commit diff stats
path: root/doc/tools.rst
blob: f407420b08158fe556674b89b87535a944e30c6e (plain) (tree)
1
2
3
4
5
6
7
8
9
10
                        
                        
                        


                                                         



                                                                               
                                            
                                                                           

                               




                                                                               
                                                                          
                                                                
 


                                                                 
                             
                                   



                                                         
========================
Tools available with Nim
========================

The standard distribution ships with the following tools:

- | `Hot code reloading <hcr.html>`_
  | The "Hot code reloading" feature is built into the compiler but has its own
    document explaining how it works.

- | `Documentation generator <docgen.html>`_
  | The builtin document generator ``nim doc`` generates HTML documentation
    from ``.nim`` source files.

- | `Nimsuggest for IDE support <nimsuggest.html>`_
  | Through the ``nimsuggest`` tool, any IDE can query a ``.nim`` source file
    and obtain useful information like definition of symbols or suggestions for
    completion.

- | `C2nim <https://github.com/nim-lang/c2nim/blob/master/doc/c2nim.rst>`_
  | C to Nim source converter. Translates C header files to Nim.

- | `niminst <https://nim-lang.org/docs/niminst.html>`_
  | niminst is a tool to generate an installer for a Nim program.

- | `nimgrep <nimgrep.html>`_
  | Nim search and replace utility.

- | nimpretty
  | ``nimpretty`` is a Nim source code beautifier,
    to format code according to the official style guide.