diff options
| author | Helder Magalhães <helder.magalhaes@gmail.com> | 2012-08-25 11:33:28 +0100 |
|---|---|---|
| committer | Helder Magalhães <helder.magalhaes@gmail.com> | 2012-08-25 11:33:28 +0100 |
| commit | 818a00ebc222f77e05d52e9d2ba71134f09ba40c (patch) | |
| tree | f1208f659ae7583cd868ef91a42489c1bcfda296 | |
| parent | 0d7af11b180b2ca87b931fbd54a8467130596013 (diff) | |
| download | cpulimit-818a00ebc222f77e05d52e9d2ba71134f09ba40c.tar.gz | |
Read me file improvements
Improvement:
Rework page title to heading 1 and remaining heading to level 2
Rework shell commands to appear as code blocks.
General:
Fix $ versus # inconsistencies.
Couple of grammar/case fixes.
| -rw-r--r-- | README | 36 |
1 files changed, 17 insertions, 19 deletions
@@ -1,47 +1,45 @@ CPULIMIT +======== -======= - About -======= +About +----- Cpulimit is a tool which limits the CPU usage of a process (expressed in percentage, not in CPU time). It is useful to control batch jobs, when you don't want them to eat too many CPU cycles. The goal is prevent a process from running for more than a specified time ratio. It does not change the nice value or other scheduling priority settings, but the real CPU usage. Also, it is able to adapt itself to the overall system load, dynamically and quickly. -The control of the used cpu amount is done sending SIGSTOP and SIGCONT POSIX signals to processes. -All the children processes and threads of the specified process will share the same percent of CPU. +The control of the used CPU amount is done sending SIGSTOP and SIGCONT POSIX signals to processes. +All the children processes and threads of the specified process will share the same percentage of CPU. Developed by Angelo Marletta. Please send your feedback, bug reports, feature requests or just thanks. -============================ - Get the latest source code -============================ +Get the latest source code +-------------------------- The latest available code is here: https://github.com/opsengine/cpulimit -====================== - Install instructions -====================== +Install instructions +-------------------- On Linux/OS X: -$ make -# cp src/cpulimit /usr/bin + $ make + $ cp src/cpulimit /usr/bin On FreeBSD: -$ gmake -# cp src/cpulimit /usr/bin + $ gmake + $ cp src/cpulimit /usr/bin Run unit tests: -$ ./tests/process_iterator_test + $ ./tests/process_iterator_test -=============== - Contributions -=============== + +Contributions +------------- You are welcome to contribute to cpulimit with bugfixes, new features, or support for a new OS. If you want to submit a pull request, please do it on the branch develop and make sure all tests pass. |