# Help improve the README

**URL:** <https://zola.discourse.group/t/help-improve-the-readme/802>\
**Category:** Uncategorized\
**Created:** [February 22, 2021, 1:29pm UTC](https://zola.discourse.group/t/help-improve-the-readme/802 "2021-02-22T13:29:29Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![southerntofu](https://yyz2.discourse-cdn.com/free1/user_avatar/zola.discourse.group/southerntofu/32/189_2.png) [@southerntofu](https://zola.discourse.group/u/southerntofu)\
**Post date:** [February 22, 2021, 1:29pm UTC](https://zola.discourse.group/t/help-improve-the-readme/802/1 "2021-02-22T13:29:29Z")

</div>

Hello folks, i recently started work on improving the README file [here](https://github.com/getzola/zola/pull/1373/files). You can preview these changes [here](https://github.com/southerntofu/zola/tree/docs-readme).

Don’t hesitate to submit feedback before the pull request is merged. But if you arrive too late to the discussion, it will always be possible to continue the discussion and open a new pull request.

In particular, i’m curious for feedback on the comparison table with other Static Site Generators. Should the list of features remain in a single big table, or split into separate tables like in the proposed README? This specific point can be discussed [over there](https://github.com/getzola/zola/pull/1373/files#r580054587) or in this thread 🙂

---

<div class="post-metadata">

**Author:** ![dertuxmalwieder](https://yyz2.discourse-cdn.com/free1/user_avatar/zola.discourse.group/dertuxmalwieder/32/336_2.png) [@dertuxmalwieder](https://zola.discourse.group/u/dertuxmalwieder)\
**Post date:** [February 22, 2021, 2:17pm UTC](https://zola.discourse.group/t/help-improve-the-readme/802/2 "2021-02-22T14:17:59Z")

</div>

As I really dislike both GitHub and splitting a discussion across multiple sites, I’d prefer to talk about the table splitting here:

In my opinion, the primary point of Zola’s README is: What is it, how can I help, how can I use it and what can it do? Wasting too many paragraphs on talking about _other_ software makes the README pointless. This should rather go in Zola’s actual documentation.

---

<div class="post-metadata">

**Author:** ![bwintx](https://yyz2.discourse-cdn.com/free1/user_avatar/zola.discourse.group/bwintx/32/300_2.png) [@bwintx](https://zola.discourse.group/u/bwintx)\
**Post date:** [February 23, 2021, 12:25pm UTC](https://zola.discourse.group/t/help-improve-the-readme/802/3 "2021-02-23T12:25:03Z")

</div>

> [@dertuxmalwieder](#):
>
> In my opinion, the primary point of Zola’s README is: What is it, how can I help, how can I use it and what can it do? Wasting too many paragraphs on talking about _other_ software makes the README pointless. This should rather go in Zola’s actual documentation.

It makes sense to have the comparison in both places, actually, given that many may well discover Zola strictly through GitHub due to the latter’s “explore” functionality.