Commits

Juri Pakaste committed 15b3f8d

README cleanup

Comments (0)

Files changed (1)

    }
  }
 
-You can use ``-`` as the file name, in which case ``nsstringfromenumgen`` expects to receive the file contents from standard input. You can use this to feed a single enum definition ``nsstringfromenumgen``, instead of a whole source file. However, if you're using the recently added ``NS_ENUM`` and ``NS_OPTIONS`` macros, you'll need to use the ``--include`` flag to include ``NSObjCRuntime.h`` (or another header that includes it, such as ``Foundation.h``.)
+You can use ``-`` as the file name, in which case ``nsstringfromenumgen`` expects to receive the file contents from standard input. You can use this to feed a single enum definition ``nsstringfromenumgen``, instead of a whole source file.
+
+If your code relies on a prefix header, like for ``NS_ENUM`` or ``NS_OPTIONS``, you need to include it on the command line with the ``--include`` flag. You can specify more than one of them if necessary. You probably want ``NSObjCRuntime.h`` or another header that includes it, such as ``Foundation.h``.
 
 Another option for including partial code is ``--text`` which allows you to supply the code as a string parameter, eg ``nsstringfromenumgen --text "typedef enum { TestEnumFirst, TestEnumSecond } TestEnum;"``. And as above you use the ``--include`` flag for headers. This option is useful at least with AppCode which doesn't support Services but has the External Tools section in Preferences.
 
-If your code relies on a prefix header, you need to include it on the command line with the ``--include`` flag. You can specify more than one of them if necessary.
-
 You can also instruct ``nsstringfromenumgen`` to treat your enums as options for a bitmask by including the ``--mask`` flag::
 
  $ nsstringfromenumgen Foo.h --mask
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.