diff --git a/README.md b/README.md index 70dfce2..7364d8f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ -#**hardware-info** +# **hardware-info** + Simple rust CLI tool to quickly gather some useful hardware and software information. This is not meant to be a glorious do all tool, just something that can grab useful information and dump it to the terminal. Yes there are other tools that can do this. I am aware. -##**DEPENDENCIES** +## **DEPENDENCIES** + * Linux : the code is written to presume linux kernel /proc/ paths and other linux tools. * nmcli : this is for grabbing network related data -##**QUICK INSTALLATION** +## **QUICK INSTALLATION** + To install this application you can use cargo to do all the work: ``` @@ -20,7 +23,8 @@ That's it! It will download the source, compile, and install the binary. You w Replace the ___~___ with your proper path to your home directory (/home/your-username/.cargo/bin) -##**MANUAL COMPILE** +## **MANUAL COMPILE** + To do things the manual way, clone the git repository ```