Skip to content

Commit

Permalink
Add usage and build info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hollasch committed Oct 16, 2016
1 parent 6a312ef commit 591ecf2
Showing 1 changed file with 49 additions and 4 deletions.
53 changes: 49 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,30 @@ It handles local drives, network-mapped drives, and removable drives. This
command takes no arguments.


Building
--------
Usage
-----

This project is managed with Visual Studio. It is built as a 64-bit application.
```
drives 1.0
drives: Print drive and volume information.
Usage: drives [/?|-h|--help] [--version] [-v|--verbose] [-p|--parseable]
[drive]
There's also a makefile that will build netuse, an experimental tool for now.
Single letter options may use either dashes (-) or slashes (/) as option
prefixes, and are case insensitive. This program also prints all network
mappings and drive substitutions (see the 'subst' command).
--help / -h Print help information.
--verbose / -v Print verbose; print additional information (only affects
human format).
--version Print program version.
--parseable / -p Print results in machine-parseable format.
[drive] Drive letter for single drive report.
```


Sample Output
Expand All @@ -28,6 +46,33 @@ Sample Output
X: "Data" 3642-e068 Fixed [NTFS] --> A:\setup\apps


Developing
----------

This project is managed with Visual Studio. It is built as a 64-bit application.
However, it is structured in a way that is friendly to add build setups from
other environments. Here's the overall tree structure:

+---src
^---build
| ^---win
^---out
^---x64
^---Debug
| ^---intermediate
| ^---drives.tlog
^---Release
^---intermediate
^---drives.tlog

Pure source files are in the `src` directory. The `build` directory contains all
of the configuration for build tools. For now, it just has the Visual Studio
build environment, in `build/win`. All generated build output goes to the `out`
directory (it's always safe to delete the entire `out` directory).

There's also a makefile that will build netuse, an experimental tool for now.


--------------------------------------------------------------------------------
Steve Hollasch <[email protected]>
https://github.com/hollasch/drives
Expand Down

0 comments on commit 591ecf2

Please sign in to comment.