1
0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-16 17:12:21 +03:00

148 Commits

Author SHA1 Message Date
A_D
0577c08d54
Fixed module docstring 2020-09-22 15:20:46 +02:00
A_D
470cbaa146
Added example plugin 2020-09-22 15:20:45 +02:00
Athanasius
8ee20039f8 Comments out py2exe in requirements-dev.txt as it trips up GitHub Actions
docs/Releasing.md has fuller instructions on getting that specific
pyexe version installed anyway.
2020-08-27 12:11:49 +01:00
Athanasius
af3e8f29c7 Updated docs
Added linting, testing, and new requirements-dev.txt instructions
2020-08-27 12:10:06 +01:00
Athanasius
2a09874554 Merge branch 'releases' into stable 2020-08-26 22:49:28 +01:00
Athanasius
f21bad8fae Releasing.md: Now using Python 3.7.9 2020-08-26 14:31:23 +01:00
Athanasius
837ac588cb Comments out py2exe in requirements-dev.txt as it trips up GitHub Actions
docs/Releasing.md has fuller instructions on getting that specific
pyexe version installed anyway.
2020-07-30 08:52:06 +01:00
Athanasius
be6a7bcdc5 Releasing.md: Emphasises that sparkle:version is SemVer string. 2020-07-30 08:51:21 +01:00
Athanasius
f849f010e2 Releasing.md: Update 'Known Issues' after a stable release. 2020-07-30 08:51:21 +01:00
A_D
7de06fb6ef Updated docs
Added linting, testing, and new requirements-dev.txt instructions
2020-07-30 08:51:21 +01:00
Athanasius
9e4fcdc497 Releasing.md: Fixups
* Contributing.md is in parent directory.
2020-07-19 15:14:16 +01:00
Athanasius
329ef42867 Contributing.md: Fixups
* Reference to Version Strings doesn't need 'URL' as text.
* We're in docs, so just 'Contributing.md'.
* Changelog.md is in parent directory.
2020-07-19 15:11:17 +01:00
Athanasius
ead292ee3a Releasing.md: Fix section headings
Why does ##Header only work in the Wiki :P ?
2020-07-19 14:48:25 +01:00
Athanasius
4d39b704cb Releasing.md: Update for fully using Semantic Versions now
* Lots of re-flow formatting for correct line-wrap.
* Change version 'number' to 'string' throughout.
* Example version is now `4.0.2`.
* #Version-Strings here is now *the* definition of the format and rules
 we use.
* Advise forks to use `+<myversion>` to differentiate.
* Point out the extra `edmarketconnector.xml` commit to update `length`.
2020-07-19 14:45:20 +01:00
Athanasius
3abd4455df Releasing.md: Cursory update for Semantic Versions 2020-07-19 11:45:07 +01:00
Athanasius
0d045d54f4 docs/Releasing.md: re-structure and clarifications.
I'd been deviating slightly from what it said, so I've updated to what I
now actually do.
2020-07-13 17:46:57 +01:00
Athanasius
1fd35bb119 Change URL branch 'develop' to 'main' in docs 2020-07-10 11:15:26 +01:00
Athanasius
733047c11b Releasing.md: Release tags are Release/A.B.C.D 2020-07-06 16:04:27 +01:00
Athanasius
26da1be135 Merge branch 'issue/549-helper-scripts' into develop 2020-07-05 19:50:32 +01:00
Athanasius
2de8b9b94f docs/Translations: Finalize "don't translate" phrases immediately. 2020-07-05 16:16:18 +01:00
Athanasius
eecd64c8ef You need 'npm' installed to update coriolis-data
And that's where some other files come from: modules.p, ships.p
2020-07-02 18:02:45 +01:00
Athanasius
5cfbb8eb12 Start documenting necessary pre-packaging actions. 2020-07-02 16:29:10 +01:00
Athanasius
2dddffd1f7 Add the new languages to the installed files.
* You need to add a 'Directory' entry for the new file *and* then list it in 'Features'.
 * Translations.md updated with the necessary steps.

closes #547
2020-07-02 15:59:10 +01:00
Athanasius
71ae6b8a34 Releasing.md: Add notes on Pre-Releases. 2020-07-01 17:21:30 +01:00
Athanasius
f10ac1d97e Fix two typoes in docs/Translations.md 2020-07-01 16:02:25 +01:00
Athanasius
4cf03b4331 Document how to add a new translation language 2020-07-01 15:55:37 +01:00
Athanasius
c019166ffb Document using other translations within a string
This is useful for things like referring to the translated name of a
menu label in some other text.
2020-07-01 15:55:37 +01:00
Athanasius
0bf8ad428c Document how translations work 2020-07-01 15:55:37 +01:00
Athanasius
79d376953d RELEASING.md doesn't need to shout 2020-06-30 16:40:40 +01:00
Athanasius
60d58fd852 Mention updating translations in release docs. 2020-06-28 16:45:49 +01:00
Athanasius
d8a76fd085 Merge branch 'feature/525-common-changelog' into python3 2020-06-28 16:19:20 +01:00
Athanasius
c2dc5a62f1 Update RELEASING.md for using full version numbers.
I've also re-done the release actions/order to actually push the
release-A.B.C.D branch up to github, along with the rel-A.B.C.D tag on
its HEAD.  This way the final release step is a merge of release-A.B.C.D
into releases, which could even be done directly on github.
2020-06-28 16:17:14 +01:00
Athanasius
fa9ed8cc81 docs: RELEASING: Update pip/modules requirements
* Confirmed requirements,txt contents work, NB: Need to have already
   installed py2exe as pip won't find a valid version.
 * Document using requirements.txt, now that it's up to date.
 * So that isn't part of the py2exe section now.
2020-06-22 00:18:47 +01:00
Athanasius
20aaca3bb2 docs: RELEASING: You REALLY need to update that install URL 2020-06-21 19:24:37 +01:00
Athanasius
a5edde146e docs: RELEASING.md: Various changes after confirming releasing works.
* Outline the `release-XYZ` > `releases` workflow.
 * Expanded on exact git CLI commands to use in some stages.
2020-06-17 18:04:25 +01:00
Athanasius
141609e7fb docs: RELEASING.md: github adds the Source Code files itself 2020-06-17 00:15:17 +01:00
Athanasius
381c039a31 docs: RELEASING.md: Mostly have the actual release procedure documented now.
There's a 'TODO' for generating the zip and tar.gz source files.
2020-06-17 00:15:17 +01:00
Athanasius
ade048d1fc docs: RELEASING.md: How to update edmarketconnector.xml 2020-06-17 00:15:17 +01:00
Athanasius
4459e19b47 docs: RELEASING.md: Clarify the py2exe version requirements.
0.9.3.2 will work, due to a hack in setup.py.

 0.9.4.0 is pre-release and works with or without that hack.
2020-06-17 00:15:17 +01:00
Athanasius
e008986490 docs: RELEASING.md: site-packages corrected.
This had been listing importlib_metadata, and its dependency zipp,
because it's a dependency of newer 'keyring'.   As we're hard-coding an
older 'keyring' without that dependency we don't need to list them here.
2020-06-17 00:15:17 +01:00
Athanasius
69b585ac1d docs: RELEASING.md: Reminder to check the .exe and .msi actually work. 2020-06-17 00:15:17 +01:00
Athanasius
806bea5b5c docs: RELEASING.md: Expand on how to run the py2exe command 2020-06-17 00:15:17 +01:00
Athanasius
4c7cc84a8b docs: RELEASING.md: Move site-packages list to after python/py2exe 2020-06-17 00:15:17 +01:00
Athanasius
38fc256cb0 docs: RELEASING.md: Document specific versions of site-packages modules 2020-06-17 00:15:17 +01:00
Athanasius
6d138dddd4 docs: RELEASING.md: It works with Python 3.7.7 2020-06-17 00:15:17 +01:00
Athanasius
5d8e0e4c5a docs: RELEASING.md update for checking later versions
* WiX Toolset 3.11.2
 * WinSparkle 0.7.0

NB: There's a need for a specific/older version of two python modules:
certifi and keyring, else running EDMarketConnector.exe doesn't work.
2020-06-17 00:15:17 +01:00
Athanasius
ba0fbd3ef3 docs: RELEASING.md fuilly fleshed out.
Unless I'm mistaken about the source of some necessary software/files,
or someone can only find a later/different version of them, this should
now serve as an easy guide to making EDMC releases.
2020-06-17 00:15:17 +01:00
Athanasius
d385a3c362 Initial empty RELEASING.md 2020-06-17 00:15:17 +01:00