1
0
mirror of https://github.com/TerryCavanagh/VVVVVV.git synced 2024-06-02 19:13:31 +02:00
Commit Graph

32 Commits

Author SHA1 Message Date
Misa
32e6ab6ecd README: Add step for compiling
We recently had a user come in the VVVVVV Discord not knowing that,
after running CMake, you then need to compile the game in a separate
step. This clarifies the instructions.
2024-01-22 00:18:20 -08:00
Misa
fc51c2219d README: Reword to "Viki", wordwrap line 2024-01-02 15:33:35 -08:00
Terry Cavanagh
e99c2b7487 reverted note at end of desktop_version/Readme about data.zip and distribution 2024-01-02 22:27:05 +01:00
Terry Cavanagh
f1a5857ffb Update README.md
general cleanup, added a link to Misa's very helpful guide on the vsix wiki
2024-01-02 22:27:05 +01:00
Misa
c9fd9e7924 README: Delete section on compiler quirks
This hasn't been relevant for years now. Even in 2.3, this wasn't
relevant, but we added a disclaimer saying that it only applies to 2.2.

But now issue #1052 has been opened specifically pointing to this
section as something that should be removed. Therefore, I'm removing it.
2023-11-27 13:43:23 -08:00
Misa
a46c817c69 Clarify references to Make and Play in README
Some people might be confused by the reference to M&P in the
instructions referring to downloading data.zip (#1026).

data.zip is the same between M&P and full versions of the game and is
orthogonal to which version of the game is built. Building M&P just
requires uncommenting `#define MAKEANDPLAY` in `MakeAndPlay.h`.

So clarify that you can grab data.zip from your existing copy of the
game, or from the Make and Play _page_ (not necessarily the Make and
Play edition of the game), and add instructions for building the M&P
version.

Closes #1027.
2023-10-25 16:47:25 -07:00
Dav999-v
2d6b2e685b Clarify submodules in desktop_version/README.md
VVVVVV uses submodules now, so you need to know how to initialize them.

I'm explicitly not including `git clone --recurse-submodules`. Usage of
submodules in git projects is kinda rare in my experience, so people
are used to doing simple clones, and that instruction would just result
in people being annoyed thinking they have to delete the repo they
already cloned, and clone it again except slightly differently.

It also doesn't help you if you need submodules that aren't in the
master branch (for example, if you clone my fork recursively and then
checkout the localization branch, you won't have C-HashMap and you'll
need the update command anyway). And you also need it whenever VVVVVV
updates its submodules. So teaching people just the update command is
better.
2022-10-16 09:56:34 -07:00
Misa
16ad8c531e Update to SDL 2.24.0
This updates all references to SDL 2.0.22 to SDL 2.24.0, including the
Docker container that I maintain for Linux CI.

Be warned, this release of SDL updates the versioning scheme to be less
dumb. The previous version is 2.0.22, this release is 2.24.0 (so the
last number can be properly used for patch-level version releases).
2022-08-21 16:07:51 -07:00
Misa
eb46143098 Update SDL version to 2.0.22
2.0.22 just released 40 minutes ago.

This also updates the `Dockerfile` to use the URL from the GitHub
releases page, instead of SDL's servers.

I've also pushed a new Docker container to
`ghcr.io/infoteddy/vvvvvv-build`.
2022-04-25 13:09:57 -07:00
Ethan Lee
b3f645d84c
README: Minor adjustments to dependencies text 2022-03-24 19:28:03 -04:00
N00byKing
f877eb3b56 Port to FAudio 2022-03-24 16:19:29 -07:00
Misa
1d3ff5fbba Update README.md to refer to SDL 2.0.20
It's now the minimum version, so it needs to be updated.
2022-02-11 17:31:41 -05:00
Misa
a6728c4648 README.md: Link to #618 for old Ubuntu versions
While we can't fix Canonical, we can at least work around them, and help
people on Ubuntu out by linking them to my comment listing the
currently-known workarounds.
2021-11-14 10:11:33 -08:00
Misa
409f7b078f Update SDL version in README.md to 2.0.16
The game uses SDL 2.0.16 now. In fact, it already uses SDL 2.0.17 as
well, and will be definitely using SDL 2.0.18 when it releases.
2021-09-24 21:33:10 -07:00
Misa
69e36229ec Add -A Win32 flag to README
This avoids failure modes made possible by mismatching 32-bit and 64-bit
settings.
2021-08-26 13:29:05 -07:00
Misa
950b9523ce Add Visual Studio string list
If people compile with VS 2019, then putting in VS 2010 will just result
in a weird error that's not really indicative of anything.
2021-08-24 09:11:02 -07:00
treacherousfiend
f77723d12f Update project generation snippet
The project generation code snippet currently still references SDL2 2.0.10 even though building now requires 2.0.14, just a minor nitpick on my part.
2021-07-25 14:36:51 -04:00
Misa
4e12c162d4 Add SDL2 version number to desktop_version/ README
As a partial fix for #618, adding the SDL2 version number to the README
will clarify that you need a specific version of SDL2 in order to
compile (and run) the current version of the game (2.3 at the time of
writing); in the future, the SDL2 dependency will be upgraded with each
SDL release.

This is to avoid error messages that complain about missing symbols like
SDL_zeroa() (added in SDL 2.0.14) not being present at the time of
compilation.

Closes #626.
2021-03-17 10:58:13 -04:00
Misa
33aed057ba Add note to README about "compiler quirks" only applying to 2.2
Only the 2.2 version has these problems, so you don't need to worry
about this section when compiling 2.3.
2020-06-21 20:51:04 -04:00
Ethan Lee
8826f57cc2 macOS builds also require self-built Vorbisfile 2020-01-14 10:16:15 -05:00
Terry Cavanagh
5b4de5b065
Updated link to make and play edition 2020-01-13 19:38:16 +01:00
Ethan Lee
6a7e848426 Add note about Windows .lib weirdness 2020-01-12 22:36:57 -05:00
Ethan Lee
901de4166e Linux can use -devel, unless their distro is super old 2020-01-11 11:43:36 -05:00
Elliott Saltar
525e868399 Correct "seperately" to "separately" 2020-01-10 20:46:25 -05:00
Ethan Lee
eb6604aa74 CMake might get fussy about relative paths, just use C:\ for the example 2020-01-10 19:51:41 -05:00
Ethan Lee
40716742e1 Note location of data.zip 2020-01-10 13:39:18 -05:00
Terry Cavanagh
c90b7316d6
Update README.md 2020-01-10 19:28:58 +01:00
Terry Cavanagh
07542ef91b
Update README.md 2020-01-10 19:28:27 +01:00
Ethan Lee
3e48661473 Clarify dev libs line 2020-01-10 12:14:37 -05:00
Ethan Lee
8529869801 This used to be true! 2020-01-10 12:13:07 -05:00
Ethan Lee
ac0692f989 Link to SDL2/SDL2_mixer 2020-01-10 12:12:00 -05:00
Ethan Lee
f7c0321b71 Hello WWWWWWorld! 2020-01-08 10:37:50 -05:00