Improve readme markdown

README.md

@@ -4,7 +4,7 @@ vk-mem
 [![vk-mem on travis-ci.com](https://travis-ci.com/gwihlidal/vk-mem-rs.svg?branch=master)](https://travis-ci.com/gwihlidal/vk-mem-rs)
 [![Latest version](https://img.shields.io/crates/v/vk-mem.svg)](https://crates.io/crates/vk-mem)
 [![Documentation](https://docs.rs/vk-mem/badge.svg)](https://docs.rs/vk-mem)
-[![](https://tokei.rs/b1/github/gwihlidal/vk-mem-rs)](https://github.com/gwihlidal/vk-mem-rs)
+[![Lines of Code](https://tokei.rs/b1/github/gwihlidal/vk-mem-rs)](https://github.com/gwihlidal/vk-mem-rs)
 ![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
 ![APACHE2](https://img.shields.io/badge/license-APACHE2-blue.svg)
 
@@ -20,65 +20,68 @@ This crate provides an FFI layer and idiomatic rust wrappers for the excellent A
 ## Problem
 
 Memory allocation and resource (buffer and image) creation in Vulkan is difficult (comparing to older graphics API-s, like D3D11 or OpenGL) for several reasons:
-* It requires a lot of boilerplate code, just like everything else in Vulkan, because it is a low-level and high-performance API.
-* There is additional level of indirection: VkDeviceMemory is allocated separately from creating VkBuffer/VkImage and they must be bound together. The binding cannot be changed later - resource must be recreated.
-* Driver must be queried for supported memory heaps and memory types. Different IHVs provide different types of it.
-* It is recommended practice to allocate bigger chunks of memory and assign parts of them to particular resources.
+
+- It requires a lot of boilerplate code, just like everything else in Vulkan, because it is a low-level and high-performance API.
+- There is additional level of indirection: VkDeviceMemory is allocated separately from creating VkBuffer/VkImage and they must be bound together. The binding cannot be changed later - resource must be recreated.
+- Driver must be queried for supported memory heaps and memory types. Different IHVs provide different types of it.
+- It is recommended practice to allocate bigger chunks of memory and assign parts of them to particular resources.
 
 ## Features
 
 This crate can help game developers to manage memory allocations and resource creation by offering some higher-level functions:
-* Functions that help to choose correct and optimal memory type based on intended usage of the memory.
-    * Required or preferred traits of the memory are expressed using higher-level description comparing to Vulkan flags.
-* Functions that allocate memory blocks, reserve and return parts of them (VkDeviceMemory + offset + size) to the user.
-    * Library keeps track of allocated memory blocks, used and unused ranges inside them, finds best matching unused ranges for new allocations, respects all the rules of alignment and buffer/image granularity.
-* Functions that can create an image/buffer, allocate memory for it and bind them together - all in one call.
+
+- Functions that help to choose correct and optimal memory type based on intended usage of the memory.
+  - Required or preferred traits of the memory are expressed using higher-level description comparing to Vulkan flags.
+- Functions that allocate memory blocks, reserve and return parts of them (VkDeviceMemory + offset + size) to the user.
+  - Library keeps track of allocated memory blocks, used and unused ranges inside them, finds best matching unused ranges for new allocations, respects all the rules of alignment and buffer/image granularity.
+- Functions that can create an image/buffer, allocate memory for it and bind them together - all in one call.
 
 Additional features:
-* Cross-platform
-    * Windows
-    * Linux
-    * macOS (MoltenVK)
-* Well tested and documented API
-    * Underlying library ships in a number of commerical game titles.
-    * Extensive documentation (including full algorithm descriptions in the VMA repository)
-* Support for custom memory pools:
-    * Create a pool with desired parameters (e.g. fixed or limited maximum size)
-    * Allocate memory out of it.
-    * Support for a linear or buddy allocation strategy
-    * Create a pool with linear algorithm and use it for much faster allocations and deallocations in free-at-once, stack, double stack, or ring buffer fashion.
-* Detailed statistics:
-    * Globally, per memory heap, and per memory type.
-    * Amount of memory used
-    * Amount of memory unused
-    * Number of allocated blocks
-    * Number of allocations
-    * etc.
-* Debug annotations:
-    * Associate string with name or opaque pointer to your own data with every allocation.
-* JSON dump:
-    * Obtain a string in JSON format with detailed map of internal state, including list of allocations and gaps between them.
-    * Convert this JSON dump into a picture to visualize your memory. See [tools/VmaDumpVis](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator/blob/master/tools/VmaDumpVis/README.md).
-* Support for memory mapping:
-    * Reference-counted internally.
-    * Support for persistently mapped memory; just allocate with appropriate flag and you get access to mapped pointer.
-* Support for defragmenting allocations:
-    * Call one function and let the library move data around to free some memory blocks and make your allocations better compacted.
-* Support for lost allocations:
-    * Allocate memory with appropriate flags and let the library remove allocations that are not used for many frames to make room for new ones.
-* Support for non-coherent memory and flushing allocations:
-    * `nonCoherentAtomSize` is respected automatically.
-* Supporting for attempting to detect incorrect mapped memory usage:
-    * Enable initialization of all allocated memory with a bit pattern to detect usage of uninitialized or freed memory.
-    * Enable validation of a magic number before and after every allocation to detect out-of-bounds memory corruption.
+
+- Cross-platform
+  -Windows
+  - Linux
+  - macOS (MoltenVK)
+- Well tested and documented API
+  - Underlying library ships in a number of commerical game titles.
+  - Extensive documentation (including full algorithm descriptions in the VMA repository)
+- Support for custom memory pools:
+  - Create a pool with desired parameters (e.g. fixed or limited maximum size)
+  - Allocate memory out of it.
+  - Support for a linear or buddy allocation strategy
+  - Create a pool with linear algorithm and use it for much faster allocations and deallocations in free-at-once, stack, double stack, or ring buffer fashion.
+- Detailed statistics:
+  - Globally, per memory heap, and per memory type.
+  - Amount of memory used
+  - Amount of memory unused
+  - Number of allocated blocks
+  - Number of allocations
+  - etc.
+- Debug annotations:
+  - Associate string with name or opaque pointer to your own data with every allocation.
+- JSON dump:
+  - Obtain a string in JSON format with detailed map of internal state, including list of allocations and gaps between them.
+  - Convert this JSON dump into a picture to visualize your memory. See [tools/VmaDumpVis](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator/blob/master/tools/VmaDumpVis/README.md).
+- Support for memory mapping:
+  - Reference-counted internally.
+  - Support for persistently mapped memory; just allocate with appropriate flag and you get access to mapped pointer.
+- Support for defragmenting allocations:
+  - Call one function and let the library move data around to free some memory blocks and make your allocations better compacted.
+- Support for lost allocations:
+  - Allocate memory with appropriate flags and let the library remove allocations that are not used for many frames to make room for new ones.
+- Support for non-coherent memory and flushing allocations:
+  - `nonCoherentAtomSize` is respected automatically.
+- Supporting for attempting to detect incorrect mapped memory usage:
+  - Enable initialization of all allocated memory with a bit pattern to detect usage of uninitialized or freed memory.
+  - Enable validation of a magic number before and after every allocation to detect out-of-bounds memory corruption.
 
 ## Planned Features
 
-* Extensive unit tests and examples.
-    * Some unit tests already, but not full coverage
-    * Example isn't written - likely will port the VMA sample to `ash` and `vk_mem`
-* Record and replay allocations, for in-depth analysis of memory usage, resource transitions, etc
-    * Check for correctness, measure performance, and gather statistics.
+- Extensive unit tests and examples.
+  - Some unit tests already, but not full coverage
+  - Example isn't written - likely will port the VMA sample to `ash` and `vk_mem`
+- Record and replay allocations, for in-depth analysis of memory usage, resource transitions, etc
+  - Check for correctness, measure performance, and gather statistics.
 
 ## Example
 
@@ -111,16 +114,17 @@ allocator.destroy_buffer(buffer, &allocation).unwrap();
 
 With this one function call (`vk_mem::Allocator::create_buffer`):
 
-* `ash::vk::Buffer` (`VkBuffer`) is created.
-* `ash::vk::DeviceMemory` (`VkDeviceMemory`) block is allocated if needed.
-* An unused region of the memory block is bound to this buffer.
-* `vk_mem::Allocation` is created that represents memory assigned to this buffer. It can be queried for parameters like Vulkan memory handle and offset.
+- `ash::vk::Buffer` (`VkBuffer`) is created.
+- `ash::vk::DeviceMemory` (`VkDeviceMemory`) block is allocated if needed.
+- An unused region of the memory block is bound to this buffer.
+- `vk_mem::Allocation` is created that represents memory assigned to this buffer. It can be queried for parameters like Vulkan memory handle and offset.
 
 ## MoltenVK
 
 For MoltenVK on macOS, you need to have the proper environment variables set. Something like:
+
 ```bash
-export SDK_PATH=/path/to/vulkansdk-macos-1.1.92.0
+export SDK_PATH=/path/to/vulkansdk-macos-1.1.101.0
 export DYLD_LIBRARY_PATH=$SDK_PATH/macOS/lib
 export VK_ICD_FILENAMES=$SDK_PATH/macOS/etc/vulkan/icd.d/MoltenVK_icd.json
 export VK_LAYER_PATH=$SDK_PATH/macOS/etc/vulkan/explicit_layer.d
@@ -146,8 +150,8 @@ extern crate vk_mem;
 
 Licensed under either of
 
- * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
 
 at your option.
 
@@ -162,8 +166,7 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
 for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
 be dual licensed as above, without any additional terms or conditions.
 
-Contributions are always welcome; please look at the [issue tracker](https://github.com/gwihlidal/vk-mem-rs/issues) to see what
-known improvements are documented.
+Contributions are always welcome; please look at the [issue tracker](https://github.com/gwihlidal/vk-mem-rs/issues) to see what known improvements are documented.
 
 ## Code of Conduct