Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

readme stuff

  • Loading branch information...
commit caf7ccf87eefdcd59d288626051c7b0f50359b42 1 parent 4c291ad
Aaron Torgerson authored May 29, 2011

Showing 1 changed file with 13 additions and 13 deletions. Show diff stats Hide diff stats

  1. 26  README.markdown
26  README.markdown
Source Rendered
... ...
@@ -1,23 +1,24 @@
1 1
 SlimJim
2  
-=======
  2
+=====
3 3
 
4 4
 SlimJim is a Visual Studio solution file generator.
5 5
 
6  
-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:
7  
-1. The name mathes one of the target project files.
8  
-2. The project has a dependency on one or more of the target project files.
9  
-3. One of the target project files has a dependency on it.
10  
-4. Any project to be included in the solution has a project reference to it. 
  6
+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:
  7
+1. The name matches one of the target project files.
  8
+1. The project has a dependency on one or more of the target project files.
  9
+1. One of the target project files has a dependency on it.
  10
+1. Any project to be included in the solution has a reference to it. 
11 11
 
12 12
 Invocation
13 13
 ----------
14 14
 
15  
-* `/r:path-to-projects-root`              Required; indicates the directory which contains the root project that you want to build a solution file for.
16  
-* `/t:target-project-name`                Required; include one or more target projects in your solution. All dependencies will be included for them.
17  
-* `/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.
18  
-* `/o:destination-path-for-solution-file` Optional; specify a directory other than the working directory to write the generated solution file.
19  
-* `/v:visual-studio-version-year`         Optional; supported versions: 2008, 2010 (default).
20  
-* `/n:solution-name`                      Optional; alternate name for generated solution file. If omitted, defaults to target project name (/t:).
  15
+* `--target ProjectName`			Required; include one or more target projects in your solution. All dependencies will be included for them. Repeat switch for multiple targets.
  16
+* `--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.
  17
+* `--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.
  18
+* `--out SolnDir` 				Optional; specify a directory other than the working or target directory to write the generated solution file.
  19
+* `--version 2008`         			Optional; supported versions: 2008, 2010 (default).
  20
+* `--name SolutionName`                     Optional; alternate name for generated solution file. If omitted, defaults to target project name.
  21
+* `--all`						Optional; indicates that all efferent assembly references should be included in the solution. By default, they are omitted.
21 22
 
22 23
 
23 24
 Upcoming features
@@ -30,5 +31,4 @@ Known issues
30 31
 ------------
31 32
 * If SlnOutputPath does not exist, an exception is raised.
32 33
 * All paths must be absolute. Relative paths for additional search paths, projects root, and solution output path will be supported soon.
33  
-* No usage instructions
34 34
 * No error handling

0 notes on commit caf7ccf

Please sign in to comment.
Something went wrong with that request. Please try again.