Skip to content

Commit

Permalink
Update README with information about Windows support
Browse files Browse the repository at this point in the history
  • Loading branch information
jaypipes committed Mar 17, 2020
1 parent 3a54316 commit 14923ea
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
![ghw mascot](images/ghw-gopher.png)
<br /><br />
`ghw` is a small Golang library providing hardware inspection and discovery
for Linux. There currently exists partial support for MacOSX and Windows
support is planned for a future release.
for Linux and Windows. There currently exists partial support for MacOSX.

## Design Principles

Expand Down Expand Up @@ -106,6 +105,10 @@ The `ghw.MemoryInfo` struct contains three fields:
resident memory size and some reserved system bits
* `ghw.MemoryInfo.SupportedPageSizes` is an array of integers representing the
size, in bytes, of memory pages the system supports
* `ghw.MemoryInfo.Modules` is an array of pointers to `ghw.MemoryModule`
structs, one for each physical [DIMM](https://en.wikipedia.org/wiki/DIMM).
Currently, this information is only included on Windows, with Linux support
[planned](https://github.com/jaypipes/ghw/pull/171#issuecomment-597082409).

```go
package main
Expand Down Expand Up @@ -263,6 +266,8 @@ Each `ghw.Disk` struct contains the following fields:
* `ghw.Disk.SizeBytes` contains the amount of storage the disk provides
* `ghw.Disk.PhysicalBlockSizeBytes` contains the size of the physical blocks
used on the disk, in bytes
* `ghw.Disk.IsRemovable` contains a boolean indicating if the disk drive is
removable
* `ghw.Disk.DriveType` is the type of drive. It is of type `ghw.DriveType`
which has a `ghw.DriveType.String()` method that can be called to return a
string representation of the bus. This string will be "HDD", "FDD", "ODD",
Expand Down Expand Up @@ -344,6 +349,9 @@ block storage (1 disk, 2TB physical storage)
### Topology

> **NOTE**: Topology support is currently Linux-only. Windows support is
> [planned](https://github.com/jaypipes/ghw/issues/166).
Information about the host computer's architecture (NUMA vs. SMP), the host's
node layout and processor caches can be retrieved from the `ghw.Topology()`
function. This function returns a pointer to a `ghw.TopologyInfo` struct.
Expand Down

0 comments on commit 14923ea

Please sign in to comment.