Improve the project's README #19

polybluez · 2025-02-11T14:26:33Z

"Re-opening" of #18. I wanted to open the PR back again, but faced some technical issues :(

cher-nov

Great and long-awaited work, thank you!

Please restore COPYING in its current form. It should be readable as plain text.
Rename README.md to ReadMe.md.
Merge everything into one ReadMe file. This is not the case when the GitHub repository also serves as a project page. We're using it only as a development resource, so it is better to focus on technical aspects here.
No need for a FAQ at the moment. It's an excessive text that requires separate care and effort for maintenance, which we currently would like to avoid.

cher-nov · 2025-02-11T14:57:12Z

README.md

@@ -0,0 +1,41 @@
+# Doom2D Forever
+**Doom2D Forever** is a recreation of the classic Doom 2D (1993) game.


No need to write project name twice.

The year of original release is already indicated in the repo description (also it's 1996, not 1993).

Suggested change

**Doom2D Forever** is a recreation of the classic Doom 2D (1993) game.

A recreation of the classic [Doom2D](https://doomwiki.org/wiki/Doom_2D) game from the late DOS era, a simulacrum of a parody - just as it should be.

Yes need. Not everyone reads the description, and the README file should also stand on its own.

Not everyone reads the description, and the README file should also stand on its own. My bad about the year.

Yes need. Not everyone reads the description, and the README file should also stand on its own.

I mean, there's already a heading with project name, so there's no need to start the paragraph with it again.

cher-nov · 2025-02-11T15:01:40Z

README.md

+<p align="center">
+    <img src="https://doom2d.org/doom2d_forever/about/DFsml.jpg" alt="Doom2D Forever, SuperDM, 640x480.">


Need more screenshots (5-7 will be enough, I guess) with static small previews instead of resized originals and left alignment. I'm going to upload them at doom2d.org and give you links a bit later.

Suggested change

<p align="center">

<img src="https://doom2d.org/doom2d_forever/about/DFsml.jpg" alt="Doom2D Forever, SuperDM, 640x480.">

<p align="center">

<img src="https://doom2d.org/doom2d_forever/about/DFsml.jpg" alt="Doom2D Forever, SuperDM, 640x480.">

cher-nov · 2025-02-11T15:31:47Z

README.md

+# Features
+- **Online multiplayer** with DM, CTF and COOP gamemodes!
+- Compared to Doom2D 1.30, the resolution of textures and sprites has been doubled
+- Bots (very aggressive ones!) are available both in singleplayer and multiplayer.
+- Russian and English localization. Да, в игре конечно же есть русский язык.
+- Multiplatform: runs on Windows, Android, macOS, Linux.
+- Cross-platform play: if your platform supports multiplayer, rest assured you can play with everybody.
+- A map editor!


Remove this section. Any promotion should go to the official website.

Why? There is no need for promotion if it's for developers? Besides, regular people visit GitHub too.

Why? There is no need for promotion if it's for developers? Besides, regular people visit GitHub too.

It's not so much about promotion, but about maintaining a clear distinction between community activity and the development process.

It's not so much about promotion, but about maintaining a clear distinction between community activity and the development process.

Ultimately, it's your call. But I would argue that screenshots fall under promotion and community activity too, and therefore should be removed.

But I would argue that screenshots fall under promotion and community activity too, and therefore should be removed.

We are talking about ReadMe here. As part of a brief introduction, they are more than adequate, and the visual information is worth a wall of text.

cher-nov · 2025-02-11T15:31:56Z

README.md

+</p>
+
+# Download and install
+Please follow the [**installation guide**](docs/INSTALL.md) to download and install Doom2D Forever.


Suggested change

Please follow the [**installation guide**](docs/INSTALL.md) to download and install Doom2D Forever.

Pre-built binaries of the latest commit (snapshot) are currently available for the following platforms and operating systems:

- **Windows** Download a ZIP-archive, either [Windows x64 (64-bit)](https://github.com/Doom2D/nixandroid/releases/latest/download/doom2df-mingw64.zip) or [**Windows x86 (32-bit)**](https://github.com/Doom2D/nixandroid/releases/latest/download/doom2df-mingw32.zip).

- **Linux** ...

- **Android** Download the [**Android APK**](https://github.com/Doom2D/nixandroid/releases/latest/download/doom2df-android.apk).

- **macOS** Download the [**macOS ZIP archive**](https://github.com/Doom2D/nixandroid/releases/latest/download/doom2df-x86_64-apple-darwin.zip). Currently only x86-64 (Intel) binaries are provided.

Yes need. It would bloat the page if (when) more installables would be added to the list. Think Windows .MSIX installers, macOS homebrew, MacPorts, macOS ZIP bundle, macOS native app, Linux Flatpak, Linux Arch, Linux ZIP archive, Linux AppImage, FreeBSD, OpenBSD, NetBSD, Solaris, Haiku, etc.

I'm not arguing. Let's solve problems as they come.

cher-nov · 2025-02-11T15:46:42Z

README.md

+# Copyright
+All rights for the resources belong to ID Software. We do not encourage and do not support any form of illegal usage of them.
+
+# License
+This project is licensed under the [**GNU General Public License v3.0**](https://github.com/Doom2D/Doom2D-Forever/blob/master/COPYING).
+
+Initially, the project was developed on [**repo.or.cz**](https://repo.or.cz/d2df-sdl.git/).


Suggested change

# Copyright

All rights for the resources belong to ID Software. We do not encourage and do not support any form of illegal usage of them.

# License

This project is licensed under the [**GNU General Public License v3.0**](https://github.com/Doom2D/Doom2D-Forever/blob/master/COPYING).

Initially, the project was developed on [**repo.or.cz**](https://repo.or.cz/d2df-sdl.git/).

# Disclaimer

This game is a fair-use parody, licensed _strictly_ under terms of the [**GNU General Public License v3.0**](https://github.com/Doom2D/Doom2D-Forever/blob/master/COPYING).

Kinda cringe, but OK.

BTW, are you sure you want to use such strong of a word as strictly? :) As I understand, Doom2D Forever was re-licensed in 2016 under GPL v3, but previous contributors were not approached about re-licensing their changes. And then it was also changed to GPL v3 only, without approaching previous contributors first.

BTW, are you sure you want to use such strong of a word as strictly? :)

Yes, as it is legal language. See this, for example: https://opensource.stackexchange.com/questions/11457/is-it-possible-that-a-future-gpl-version-removes-copyleft

but previous contributors were not approached about re-licensing their changes

They were, assuming current "Credits" screen.

And then it was also changed to GPL v3 only, without approaching previous contributors first.

Which is fine AFAIK, since this only restricts further a priori multi-licensing, while not being a relicensing by itself.

but previous contributors were not approached about re-licensing their changes

They were, assuming current "Credits" screen.

I also have a legally significant contribution, but I'm not in the "Credits" screen! Don't forget to approach me if you want to make a re-licensing decision!

BTW, are you sure you want to use such strong of a word as strictly? :)

Yes, as it is legal language. See this, for example: https://opensource.stackexchange.com/questions/11457/is-it-possible-that-a-future-gpl-version-removes-copyleft

Nevermind. I thought you wanted to emphasize that the game is licensed under GPL v3.0 :)

polybluez · 2025-02-11T16:31:25Z

Merge everything into one ReadMe file. This is not the case when the GitHub repository also serves as a project page. We're using it only as a development resource, so it is better to focus on technical aspects here.

Why not? @Jabberwock-RU всё равно не хочет заниматься лендингом и сайтом. Это легко понять, если посмотреть в веб-архив за последние 7 лет и не увидеть на сайте никаких изменений вообще.

cher-nov · 2025-02-11T16:44:17Z

Why not?

Because at this point I want to see the repository as lightweight as possible, focusing primarily on technical issues of development and building, rather than attention-grabbing.

@Jabberwock-RU всё равно не хочет заниматься лендингом и сайтом. Это легко понять, если посмотреть в веб-архив за последние 7 лет и не увидеть на сайте никаких изменений вообще.

Не думаю, что здесь подходящее место для обсуждения этого.

polybluez · 2025-02-11T17:01:12Z

Why not?

Because at this point I want to see the repository as lightweight as possible, focusing primarily on technical issues of development and building, rather than attention-grabbing.

I'm just wondering where exactly the promotion should take place, because if it's not at the GitHub page, it sure as hell is not taking place at the project's website.

BTW, which, sans the forum, could easily be redone as a static GitHub Pages deployment!

polybluez added 5 commits February 11, 2025 17:22

Spice up the documentation a little

96525ff

docs: Don't force width for the image tag in README.md

3d73169

Move the license file to the more conventional location

8db1ce9

docs: add content to "Contribution and Development"

f3e3f4a

docs: fix anchors in INSTALL.md

575705b

cher-nov requested review from cher-nov and removed request for cher-nov February 11, 2025 14:35

cher-nov requested changes Feb 11, 2025

View reviewed changes

polybluez added 9 commits February 11, 2025 19:48

Remove Features section in README.md

d288ea0

Rename README.md to ReadME.md

e6f1089

Reword About section of ReadMe

c2b2a58

Remake the legal related section in ReadMe

30191e5

Restore LICENSE to plain-text format

a9b1a83

docs: ReadME.md -> ReadMe.md

6441458

Inline download and installation in ReadMe

fc69f93

Remove FAQ from ReadMe

58ed3d1

Beautify Download and install section of ReadMe

840f95c

polybluez added 3 commits February 12, 2025 17:07

ReadMe: LICENSE -> COPYING

4114c2b

ReadMe: Inline DEVELOPMENT.md

7d16721

ReadMe: reinstate section about static linking

85a0e1e

polybluez force-pushed the master branch from ef16613 to 85a0e1e Compare February 12, 2025 14:27

polybluez requested a review from cher-nov February 12, 2025 14:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve the project's README #19

Improve the project's README #19

polybluez commented Feb 11, 2025 •

edited

Loading

cher-nov left a comment

cher-nov Feb 11, 2025

polybluez Feb 11, 2025

cher-nov Feb 11, 2025

cher-nov Feb 11, 2025

cher-nov Feb 11, 2025 •

edited

Loading

polybluez Feb 11, 2025

cher-nov Feb 11, 2025

polybluez Feb 11, 2025 •

edited

Loading

cher-nov Feb 11, 2025

cher-nov Feb 11, 2025 •

edited

Loading

polybluez Feb 11, 2025 •

edited

Loading

cher-nov Feb 11, 2025

cher-nov Feb 11, 2025

polybluez Feb 11, 2025

polybluez Feb 11, 2025

cher-nov Feb 11, 2025 •

edited

Loading

polybluez Feb 11, 2025

polybluez Feb 11, 2025 •

edited

Loading

polybluez commented Feb 11, 2025

cher-nov commented Feb 11, 2025

polybluez commented Feb 11, 2025 •

edited

Loading

		@@ -0,0 +1,41 @@
		# Doom2D Forever
		Doom2D Forever is a recreation of the classic Doom 2D (1993) game.

	Doom2D Forever is a recreation of the classic Doom 2D (1993) game.
	A recreation of the classic [Doom2D](https://doomwiki.org/wiki/Doom_2D) game from the late DOS era, a simulacrum of a parody - just as it should be.

		<p align="center">
		<img src="https://doom2d.org/doom2d_forever/about/DFsml.jpg" alt="Doom2D Forever, SuperDM, 640x480.">

-Please follow the [**installation guide**](docs/INSTALL.md) to download and install Doom2D Forever.
+Pre-built binaries of the latest commit (snapshot) are currently available for the following platforms and operating systems:
+- **Windows** Download a ZIP-archive, either [Windows x64 (64-bit)](https://github.com/Doom2D/nixandroid/releases/latest/download/doom2df-mingw64.zip) or [**Windows x86 (32-bit)**](https://github.com/Doom2D/nixandroid/releases/latest/download/doom2df-mingw32.zip).
+- **Linux** ...
+- **Android** Download the [**Android APK**](https://github.com/Doom2D/nixandroid/releases/latest/download/doom2df-android.apk).
+- **macOS** Download the [**macOS ZIP archive**](https://github.com/Doom2D/nixandroid/releases/latest/download/doom2df-x86_64-apple-darwin.zip). Currently only x86-64 (Intel) binaries are provided.

Improve the project's README #19

Are you sure you want to change the base?

Improve the project's README #19

Conversation

polybluez commented Feb 11, 2025 • edited Loading

cher-nov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cher-nov Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

polybluez Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cher-nov Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

polybluez Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cher-nov Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

polybluez Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

polybluez commented Feb 11, 2025

cher-nov commented Feb 11, 2025

polybluez commented Feb 11, 2025 • edited Loading

polybluez commented Feb 11, 2025 •

edited

Loading

cher-nov Feb 11, 2025 •

edited

Loading

polybluez Feb 11, 2025 •

edited

Loading

cher-nov Feb 11, 2025 •

edited

Loading

polybluez Feb 11, 2025 •

edited

Loading

cher-nov Feb 11, 2025 •

edited

Loading

polybluez Feb 11, 2025 •

edited

Loading

polybluez commented Feb 11, 2025 •

edited

Loading