From 8525cb0e225d652ff3ceaebe5353ad296b4b87b0 Mon Sep 17 00:00:00 2001 From: Lutz Date: Sun, 3 Apr 2022 12:16:22 +0200 Subject: [PATCH] Update to documentation --- .github/CONTRIBUTING.md | 7 ++++++- README.md | 4 ++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 10f4e35..f8e68a4 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,11 +1,14 @@ # How to contribute to FoxBin2Prg + ## Bug report? - Please check [issues](https://github.com/fdbozzo/foxbin2prg/issues) if the bug is reported - If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring. + ### Did you write a patch that fixes a bug? - Open a new GitHub merge request with the patch. - Ensure the PR description clearly describes the problem and solution. - Include the relevant version number if applicable. +- See [New version](#new-version) for additional tasks ## Coding conventions @@ -25,6 +28,7 @@ Start reading our code and you'll get the hang of it. We optimize for readabilit Please note, there are some tasks to set up a new version. Stuff is a bit scattered, so this is where to look up. 1. Please create a fork at github + - See this [guide](https://www.dataschool.io/how-to-contribute-on-github/) for setting up and using a fork 0. In _FoxBin2Prg.prg_ there are two version numbers in properties: `n_FB2PRG_Version = 1.19` `c_FB2PRG_Version_Real = '1.19.60'` @@ -35,6 +39,7 @@ Stuff is a bit scattered, so this is where to look up. The most recent entries met in the middle of this section around * 4. Alter version in _README.md_ 4. Add a description to _docs\FoxBin2Prg_Changes.md_ +6. Please alter the footer of *.md files touched to recent date. 4. If a change to the config files is made please add the description to the various properties (multi lang) - _C_FOXBIN2PRG_SYNTAX_INFO_EXAMPLE_LOC_cfg:_ for general settings - _C_FOXBIN2PRG_SYNTAX_INFO_EXAMPLE_LOC_tab_cfg:_ for settings per table @@ -64,4 +69,4 @@ In special: Thanks ---- -Last changed: _2022/03/16_ ![Picture](../docs/pictures/vfpxpoweredby_alternative.gif) \ No newline at end of file +Last changed: _2022/04/03_ ![Picture](../docs/pictures/vfpxpoweredby_alternative.gif) diff --git a/README.md b/README.md index 989dcb8..8d2fd3f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This is the perpetuation of [Fernando D. Bozzo](https://github.com/fdbozzo) foxbin2prg. It's the main tool with some bugs fixes and some new functions. -Since I know maintain this project, my [fork](https://github.com/lscheffler/foxbin2prg) is no longer in sync. +Since I now maintain this project, my [fork](https://github.com/lscheffler/foxbin2prg) is no longer in sync. The spanish documentation is not longer maintained - it would fade. For fast access a quick run is [introduced](#use-foxbin2prg), more [complex](./docs/FoxBin2Prg_Run.md#usage-1), and a large [documentation](./docs/FoxBin2Prg.md) exists too. @@ -138,4 +138,4 @@ For usage see [documentation](./docs/FoxBin2Prg.md) ## Contribution See [contribution](./.github/CONTRIBUTING.md) -Last changed: _2022/03/30_ ![Picture](./docs/pictures/vfpxpoweredby_alternative.gif) \ No newline at end of file +Last changed: _2022/03/31_ ![Picture](./docs/pictures/vfpxpoweredby_alternative.gif) \ No newline at end of file