Readme isn't up to date

[Azurency]

Issue by JHCD
Friday Feb 24, 2017 at 08:55 GMT
Originally opened as CQUI-Org/cqui#327

---

NOTE: Until this mod is in a less experimental state, the mod will not remember its "enabled" status after restarting the game. This means that every time you plan to start a new game using CQUI, you'll need to explicitly enable it in the "Additional Content" menu first. Once you've created the game using the mod, it will always load when you start the save, regardless of its current status in the "Additional Content Menu"

Is this still up-to-date?
It's always enabled here.

[Azurency]

Comment by chaorace
Friday Feb 24, 2017 at 08:58 GMT

---

No, it's no longer an up to date description. I plan to just completely rewrite the readme for the Beta release

[Azurency]

Comment by JHCD
Sunday May 21, 2017 at 07:12 GMT

---

We need a documentation of all used key bindings and mouse-click implementations too.
Has anybody an overview about the possible features?

See #536 and #529 for example...

[ricanuck]

Not only the readme, we should also work on the Steam WS description and make it actual, especially now that the C stands for Community. I would also make every file name person-neutral, get rid of any names and personalization so that we truly reflect the Community nature of this new edition (in-code comments with names are OK, and even better, as they help identify code authors for better troubleshooting)...

I can help with the descriptions, if you want..

[sparrow8332]

@ricanuck any help is appreciated mate. @Azurency is on the ball with the updates and i would have started a fresh readme and clearing out the files ect but been bogged down so much recently with work.

[ricanuck]

yeah, I know, work, that stupid invention that prevents us from civving freely... 🤣

[Azurency]

Why would we remove all the names and thanks ? I think it's good to thank the people who contributed, that the community ! Maybe just make it more compact on the readme

[sparrow8332]

or maybe even a link to a Pastebin with all the names off everyone thats helped get this to where it is Past & Present

[ricanuck]

@Azurency : Antoine, I was referring to removing names from file names... right now there are some files with user names, I meant we should make all those file names neutral... off course contributor's names should stay! But the mod itself, and any of its parts, should really be person-neutral, now that the "C" stands for COMMUNITY and not for a person... capisce? 😉

[sparrow8332]

@ricanuck ive started on sparrow8332-patch-1 branch - CQUI.modinfo for eg is this what you mean ?

[ricanuck]

Yep, that is what I mean... neutral file names. That one should just be CQUI.modinfo...

[ricanuck]

Comments inside the code are OK, in fact it's better to know who wrote what for easier troubleshooting.