Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renamed README to README.md and Beautify #22

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 35 additions & 17 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Screen Resolution

This is a tool that can be used to determine current resolution,
list available resolutions and set resolutions for active displays
on Mac OS 10.6, and possibly above. I have only tested 10.6.
Expand All @@ -6,8 +8,8 @@ I used clang for development, but the code seems to compile
just fine with gcc. The code might not be as well layed out
as it could be, feel free to send a pull request.

Build+Install
====================
### Build+Install

Running the following commands in Terminal.app will result in
dmg with a pkg file being created if the system has Xcode 4.

Expand All @@ -25,7 +27,7 @@ properly for you if you only have one
This will cause your screen to flicker as it changes the mode a
couple times on each monitor.

The makefiles support the DESTDIR (alternate root) and PREFIX
The makefiles support the `DESTDIR` (alternate root) and `PREFIX`
variables. If you don't know what those are, you probably don't
want them.

Expand All @@ -40,12 +42,12 @@ If you want to put this program on another system, you can choose
between the pkg file, the dmg file, the binaries or use the
install make target with DESTDIR to specify an alternate root.

Running
====================
There are three commands that this program supports: get, list
and set. All three modes operate on active displays [1].
### Running

There are three commands that this program supports: `get`, `list`
and `set`. All three modes operate on active displays [1].

The get mode will show you the resolution of all active displays
The `get` mode will show you the resolution of all active displays

$ screenresolution get
Display 0: 1920x1200x32
Expand All @@ -61,35 +63,51 @@ The get mode will show you the resolution of all active displays
Available Modes on Display 1
<snip>

The set command takes a list of modes. It will apply the modes
The `set` command takes a list of modes. It will apply the modes
in the list of modes to the list of displays, starting with 0.
Modes in excess of the number of active displays will be ignored.
If you wish to set a monitor but not the lower numbered displays,
there is a keyword 'skip' which can be subsituted for a resolution.
there is a keyword `skip` which can be subsituted for a resolution.
This keyword will cause the first display to be skipped. If you
specify more resolutions than you have active screens, the extra
resolutions will be ignored.

Example 1:

## Examples

__Example 1:__
>
This example works with one or more screens
$ screenresolution set 800x600x32
Result 1:

>Result:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how this formats is not ideal, imo. The text result: should not be in the quote. Otherwise this looks good and happy to merge!

>
The main display will change to 800x600x32, second screen
will not be changed

Example 2:
This example assumes two screens
__Example 2:__
>
This example assumes two screens
>
$ screenresolution set 800x600x32 800x600x32
Result 2:

>__Result:__
>
The first and second monitor on the system will be set to
800x600x32

Example 3:
This example assumes two screens
__Example 3:__

>This example assumes two screens
>
$ screen resolution set skip 800x600x32

>__Result:__
>
This will not touch the first screen but will set the second
screen to 800x600x32

___

[1]See discussion point for explanation of what active display means.
http://developer.apple.com/library/mac/documentation/GraphicsImaging/Reference/Quartz_Services_Ref/Reference/reference.html#//apple_ref/c/func/CGGetActiveDisplayList