As others have mentioned, anything obscure like this should literally come with a Wikipedia (or other such) link to explain what it is, what it does. This is the primary problem with small project READMEs, imo. They assume you're already familiar with them and know what the hell they are. Like, take Ironhide:<p><pre><code> https://github.com/MrMEEE/ironhide
Optimus Support for Linux Through VirtualGL - PPA version also available
</code></pre>
That's... great. So it's doing something with GL, and it's running on Linux, but uhhh.<p><pre><code> my branch of the original bumblebee project..
</code></pre>
What is Optimus? What is Bumblebee? The trick of it is that it links to a blog where neither of these terms are ever explained. Maybe it's to just look impressive on someone's CV? How could I even tell the difference?<p>Likewise for this project, all you need in the README is one line that's like:<p><pre><code> X-Transformers is a re-implementation of Machine Learning Transformers that has been built based on experimental Arxiv papers
</code></pre>
It's a one-line fix but it'll stop people like me being confused as to whether or not you're implementing a new HTTP header