Skip to content

Commit 9e213b5

Browse files
authored
Create README.md with setup and usage details
Add initial README with installation instructions and test commands.
1 parent caa193f commit 9e213b5

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# CoreBench - The Benchmark Built for Consumers
2+
CoreBench is a versatile CLI CPU benchmark suite built for Linux, designed from the ground up with consumers in mind.
3+
4+
## How To
5+
*Note: Python 3.11+ is required to run this program. If Python 3.14+ is not found, CoreBench will automatically install it.*
6+
7+
### Windows
8+
Download the latest release from the tag and unzip it.\
9+
Run the `corebench.bat` file to begin installation of dependencies and run CoreBench.\
10+
*Note: scores may be inaccurate on Windows compared ot the same machine running Linux, we are aiming to fix this soon.*
11+
12+
### Linux
13+
Download the latest release from the tag and unzip it.\
14+
Inside of the extracted folder, run `chmod +x corebench.sh && ./corebench.sh` to begin installation of dependencies and run CoreBench
15+
16+
#### Test Commands
17+
`sc` - Single Core\
18+
`mc` - Multi Core\
19+
`mt` - Multi Thread\
20+
`gflops` - GFLOPs test\
21+
`api` - Set the API key\
22+
`clear` - Clear the screen\
23+
`fc` - Full CPU test (scores are uploaded to https://corebench.me)
24+
25+
#### Terminal Command Execution
26+
If you provide CoreBench with command-line arguments during execution, it will behave differently on startup.\
27+
``--t <COMMAND>`` - run a test command\
28+
``--m`` - run the whole program in your current environment (not recommended)\
29+
``--b <COMMAND?>`` - create a CoreBench "build"

0 commit comments

Comments
 (0)