github.com/sercand/please@v13.4.0+incompatible/docs/quickstart.html (about)

     1  
     2      <h1>Please quickstart</h1>
     3  
     4      <h2>System requirements</h2>
     5      <p>Please supports Linux and OSX at the moment. We're internally using Ubuntu Xenial and Sierra but it should
     6        work on other reasonably recent distros.</p>
     7  
     8      <h2>Installing</h2>
     9      <p><code>curl https://get.please.build | bash</code></p>
    10      <p>This will download and install the latest version of Please on your system.<br/>
    11        It also adds itself to your <code>PATH</code>; you may need to <code>source ~/.bashrc</code>
    12        or <code>source ~/.zshrc</code> after install to get that updated.</p>
    13  
    14      <p>If you'd prefer more manual installation, grab a tarball off
    15        <a href="https://github.com/thought-machine/please/releases">our releases page</a> and extract
    16        it yourself; it normally lives in <code>~/.please</code> but you can put it where you want.</p>
    17  
    18      <h2>Shell completion</h2>
    19      <p>Please comes with a completion script for Bash and zsh built-in.</p>
    20  
    21      <p>You can produce it by running <code>plz --completion_script</code>.
    22        This is handy to add to your <code>.bashrc</code> or <code>.zshrc</code>, for example:<br/>
    23        <pre><code>source <(plz --completion_script)</code></pre></p>
    24  
    25      <p>The script will complete subcommands and flags but most relevantly can also complete
    26        build labels by reading BUILD files for you.</p>
    27  
    28      <h2>BUILD file Language Protocol Server</h2>
    29      <p>Please ships with a language server for build files. It follows the
    30          <a href="https://langserver.org/">language server protocol</a> from VS Code.</p>
    31  
    32      <p>To use LPS, simply download the language server protocol plugin for your favourite editor,
    33      and run the binary with the command <code>plz tool lps</code>.</p>
    34  
    35      <p>Currently LPS supports auto-completion (this works with build labels too!), hover, goto definition,
    36      diagnostics, signature help, auto-formatting and references.</p>
    37  
    38      <h2>Getting started</h2>
    39      <p>Run <code>plz init</code> at the root of your repo to create the .plzconfig file.
    40        There are many options that can be configured in this file but you can worry about them
    41        later - the defaults should be fine to begin with.</p>
    42  
    43      <p>You will need to write some BUILD files to define how to compile your code.
    44        Carry on to <a href="basics.html">Please Basics</a> which will explain more about it.
    45      </p>