docs/getting_started.rst in xolti-0.1.1 vs docs/getting_started.rst in xolti-0.2.0

- old
+ new

@@ -72,18 +72,12 @@ node_modules package.json .. tip:: - You can invert a rule by prefixing it with ``!``. You can create one ``.xoltignore`` - in each directory of your project. Globing (ie use of the ``*`` wildcard) is supported. + More details on ``.xoltignore`` files can be found :doc:`in the dedicated documentation page </xoltignore>` -.. note:: - - Like in a ``.gitignore`` file, rules are read line by line, from top to bottom; lower rules - override higher ones, and rules from a deeper folder override rules from higher folders. - Checking which files are missing headers ---------------------------------------- Now that xolti knows which files to handle, we can ask it which ones are missing headers. We can either use the dedicated command: @@ -92,22 +86,22 @@ [22:14 remi ~/myAwesomeProject]$ xolti list-missing Files missing (proper) header: app.js -... or use ``xolti status``, which will tell you the state of each of your files. +... or use ``xolti status``, which will report the files without correct headers. .. code-block:: bash xolti status -- ./app.js No header found. Adding the header to your files ------------------------------- -Looks like ``app.js`` is missing a header. Xolti can create and insert one for you, with the +Looks like ``app.js`` is missing a header... Xolti can create and insert one for you, with the ``add`` command: .. code-block:: bash xolti add app.js @@ -125,15 +119,15 @@ Verifying the result -------------------- Of course, you can verify that Xolti have actually added the header by simply opening the -file, but you can also use the ``check`` command: +file, but you can also use once again the ``status`` command: .. code-block:: bash - remi ~/myAwesomeProject]$ xolti check app.js + remi ~/myAwesomeProject]$ xolti status app.js Correct header. That's it ! Your project is correctly licensed :). Detecting incorrect headers @@ -141,20 +135,20 @@ Now that we think of it, ``myAwesomeProject`` is not such a good name. ``myFantasticProject`` is way better ! To let xolti know of our change of mind, we can edit the ``xolti.yml`` file, and replace the value of the key ``project_name`` by ``myFantasticProject``. -If we ``check`` again the ``app.js`` file, xolti warns us about its now incorrect header: +When we ask xolti once again about the status of the ``app.js`` file, it warns us about the now incorrect header: .. code-block:: bash - xolti check app.js + remi ~/myAwesomeProject]$ xolti status app.js Line 5: expected "myFantasticProject" but got "myAwesomeProject". Line 7: expected "myFantasticProject" but got "myAwesomeProject". Line 12: expected "myFantasticProject" but got "myAwesomeProject". Line 18: expected "myFantasticProject" but got "myAwesomeProject". -You can then correct this outdated header. +You can then manually correct this outdated header. Deleting the header in a file ----------------------------- What if you decide that you no longer needs a header in your ``app.js`` ? Simply use the