shithub: dav1d

Info  •  Files  •  Log  •  Branches

Update README.md

- Fix small typos
- Add link to doxygen documentation
- Add high bit-depth asm goals

--- a/README.md

+++ b/README.md

@@ -30,9 +30,9 @@

 1. Complete C implementation of the decoder,

 2. Provide a usable API,

 3. Port to most platforms,

-4. Make it fast on desktop, by writing asm for AVX-2 chips.

+4. Make it fast on desktop, by writing asm for AVX2 chips.

 5. Make it fast on mobile, by writing asm for ARMv8 chips,

-6. Make it fast on older desktop, by writing asm for SSSE3+ chips.

+6. Make it fast on older desktops, by writing asm for SSSE3+ chips.

 ### On-going

 7. Make it fast on older mobiles, by writing asm for ARMv7 chips,

@@ -40,7 +40,11 @@

 9. Accelerate for less common architectures, like PPC, SSE2 or AVX-512.

 ### After

-10. Use more GPU, when possible.

+10. Make high bit-depth fast on desktop, by writing asm for AVX2 chips,

+11. Make high bit-depth fast on mobile, by writing asm for ARMv8 chips,

+12. Make high bit-depth fast on older desktops, by writing asm for SSSE3+ chips,

+13. Make high bit-depth fast on older mobiles, by writing asm for ARMv7 chips,

+14. Use more GPU, when possible.

 # Contribute

@@ -130,7 +134,7 @@

 ## I am not a developer. Can I help?

-- Yes. We need testers, bug reporters, and documentation writers.

+- Yes. We need testers, bug reporters and documentation writers.

 ## What about the AV1 patent license?

@@ -142,3 +146,5 @@

 - We do, but we don't have either the time or the knowledge. Therefore, patches and contributions welcome.

+## Where can I find documentation?

+- The current library documentation, built from master, can be found [here](https://videolan.videolan.me/dav1d/).