Permalink
Browse files

readme stuff

  • Loading branch information...
1 parent 4c291ad commit caf7ccf87eefdcd59d288626051c7b0f50359b42 @AaronTorgerson committed May 29, 2011
Showing with 13 additions and 13 deletions.
  1. +13 −13 README.markdown
View
@@ -1,23 +1,24 @@
SlimJim
-=======
+=====
SlimJim is a Visual Studio solution file generator.
-SlimJim is meant to be invoked from the command line. It will search a given folder (recursively) for .csproj files, and include them in a new solution file if:
-1. The name mathes one of the target project files.
-2. The project has a dependency on one or more of the target project files.
-3. One of the target project files has a dependency on it.
-4. Any project to be included in the solution has a project reference to it.
+SlimJim is meant to be invoked from the command line. It will search a given directory recursively for .csproj files, and include them in a new solution file if:
+1. The name matches one of the target project files.
+1. The project has a dependency on one or more of the target project files.
+1. One of the target project files has a dependency on it.
+1. Any project to be included in the solution has a reference to it.
Invocation
----------
-* `/r:path-to-projects-root` Required; indicates the directory which contains the root project that you want to build a solution file for.
-* `/t:target-project-name` Required; include one or more target projects in your solution. All dependencies will be included for them.
-* `/a:path-to-include-in-search` Optional; specify one or more directories to search for projects that depend on or are depdended on by the target projects.
-* `/o:destination-path-for-solution-file` Optional; specify a directory other than the working directory to write the generated solution file.
-* `/v:visual-studio-version-year` Optional; supported versions: 2008, 2010 (default).
-* `/n:solution-name` Optional; alternate name for generated solution file. If omitted, defaults to target project name (/t:).
+* `--target ProjectName` Required; include one or more target projects in your solution. All dependencies will be included for them. Repeat switch for multiple targets.
+* `--root C:\Projects\Root` Optional; indicates the directory which contains the root project that you want to build a solution file for. Defaults to the working directory.
+* `--search C:\Additional\Search\Path` Optional; specify one or more directories to search for projects that depend on or are depdended on by the target projects.
+* `--out SolnDir` Optional; specify a directory other than the working or target directory to write the generated solution file.
+* `--version 2008` Optional; supported versions: 2008, 2010 (default).
+* `--name SolutionName` Optional; alternate name for generated solution file. If omitted, defaults to target project name.
+* `--all` Optional; indicates that all efferent assembly references should be included in the solution. By default, they are omitted.
Upcoming features
@@ -30,5 +31,4 @@ Known issues
------------
* If SlnOutputPath does not exist, an exception is raised.
* All paths must be absolute. Relative paths for additional search paths, projects root, and solution output path will be supported soon.
-* No usage instructions
* No error handling

0 comments on commit caf7ccf

Please sign in to comment.