README.md: add more FAQ

Conversation 3 Commits 2 Files Changed 1

arwagner commented

Add more details to the FAQ section based on discussions in issues
Reformat subheadings for FAQ from italics to ### headings.

Addresses Starfish/TinyWeatherForecastGermany#86

- Add more details to the FAQ section based on discussions in issues - Reformat subheadings for FAQ from _italics_ to ### headings. Addresses Starfish/TinyWeatherForecastGermany#86

👍 1

arwagner added 1 commit

5703ec2a6d README.md: add more FAQ

- Add more details to the FAQ section based on discussions in issues
- Reformat subheadings for FAQ from _italics_ to ### headings.

Closes #1
Addresses Starfish/TinyWeatherForecastGermany#86

eUgEntOptIc44 commented

sounds like a good idea to me. changing to headings will add these to table of contents (ToC) auto-generated by e.g. GitHub ... and here as well.

I also thought it might be nice to have a (more) user friendly way to search the contents of areas.txt -> please see here (gets updated via GitLab CI/CD once per day at 6:05am UTC)

One might simply load the original 'raw' file but this is load intensive when using Web UI or requires downloading/cloning the repository.

Using the search function of one of the repo mirrors (GitHub, GitLab) hosts might be in general a nice pointer for new users as the search capability is not yet offered here at codeberg see here for progress on this topic.

The processed data is also available in JSON format to ease further integrations.

sounds like a good idea to me. changing to headings will add these to **table of contents** (ToC) auto-generated by e.g. [GitHub](https://github.com/twfgcicdbot/TinyWeatherForecastGermanyMirror#readme) ... and [here](https://tinyweatherforecastgermanygroup.gitlab.io/index/index.html) as well. --- I also thought it might be nice to have a (more) user friendly way to search the contents of [`areas.txt`](https://codeberg.org/Starfish/TinyWeatherForecastGermany/src/commit/3a75d62ae06e6e4e03a6af3bc865dfbb5bf334c9/app/src/main/res/raw/areas.txt) -> please see [here](https://tinyweatherforecastgermanygroup.gitlab.io/index/areas.html) *(gets updated via GitLab CI/CD once per day at 6:05am UTC)* One might simply load the original 'raw' file but this is load intensive when using Web UI or requires downloading/cloning the repository. Using the **search** function of one of the **repo mirrors** ([GitHub](https://github.com/twfgcicdbot/TinyWeatherForecastGermanyMirror), [GitLab](https://gitlab.com/tinyweatherforecastgermanygroup/TinyWeatherForecastGermany)) hosts might be in general a nice pointer for new users as the search capability is **not yet** offered here at codeberg see [here for progress](https://codeberg.org/Codeberg/Community/issues/379) on this topic. The processed data is also available in [JSON format](https://tinyweatherforecastgermanygroup.gitlab.io/index/twfg-areas.json) to ease further integrations.

arwagner commented

Poster

addresses: #76

👍 1

arwagner added 1 commit

019ad469cb README.md: add hint on hints

Add a note about the hints functionality to the README.

Addresses #1
Addresses Starfish/TinyWeatherForecastGermany#85

Starfish merged commit 94d5317212 into master 2 years ago

Starfish referenced this issue from a commit

Merge pull request 'README.md: add more FAQ' (#90) from arwagner/TinyWeatherForecastGermany:1_EnhanceReadme into master

Starfish commented

Owner

merged, thanks!

👍 2

arwagner deleted branch 1_EnhanceReadme

The pull request has been merged as 94d5317212.

You can also view command line instructions.

Step 1:

From your project repository, check out a new branch and test the changes.

git checkout -b arwagner-1_EnhanceReadme master

git pull 1_EnhanceReadme

Step 2:

Merge the changes and update on Forgejo.

git checkout master

git merge --no-ff arwagner-1_EnhanceReadme

git push origin master

Sign in to join this conversation.

No reviewers

No Label

No Milestone

No Assignees

3 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Loading…

There is no content yet.

Labels Milestones

README.md: add more FAQ #90

Step 1:

Step 2: