First commit

Signed-off-by: Mattias Andrée <maandree@kth.se>

1 files changed, 41 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..bbb5a4f
--- /dev/null
+++ b/README
@@ -0,0 +1,41 @@
+MAME
+	coreup - Enable all CPU core
+	coredown - Disable all but one CPU core
+
+SYNPOSIS
+	coreup [count]
+	coredown [count]
+
+DESCRIPTION
+	The coreup utility enables all CPU cores on the machine.
+
+	The coredown utility disables all CPU cores on the machine
+	expect the CPU 0.
+
+	This is designed as a workaround for virtual machines that
+	have input performance issues (keyboard input lag and keys
+	getting stuck) when more than one CPU core is online.
+
+OPTIONS
+	No options are supported.
+
+OPERANDS
+	The following operand is supported:
+
+	count
+		Enable the first count CPU cores and disable the rest.
+
+EXIT STATUS
+	If the coreup and coredown utility fails it will exit with one
+	of the following statuses:
+
+	0	Successful completion.
+
+	1	An error occurred.
+
+NOTES
+	The is no difference between the coreup(1) and coredown(1)
+	utilities when the count operand is specified.
+
+SEE ALSO
+	None.