From 843f7eb7103c41b12d3f9132396d8b011b465e2c Mon Sep 17 00:00:00 2001 From: Ryo Nakano Date: Wed, 9 Jul 2025 21:23:07 +0900 Subject: [PATCH 1/2] Update documentations --- CONTRIBUTING.md | 22 --------------- README.md | 69 +++++------------------------------------------- RELEASE_HOWTO.md | 38 -------------------------- 3 files changed, 7 insertions(+), 122 deletions(-) delete mode 100644 CONTRIBUTING.md delete mode 100644 RELEASE_HOWTO.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index a4f4b99..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,22 +0,0 @@ -# Contribution Guideline -Thank you for getting interested in contributing to the project! We really appreciate it. 😊 - -## Submit Bug Reports or Feature Requests -1. [Search for existing issues](https://github.com/ryonakano/atlas/issues) to check if it's a known issue. -2. [Create a new issue](https://github.com/ryonakano/atlas/issues/new) if it's not reported yet. - -> [!TIP] -> If you are not used to do, [this section](https://docs.elementary.io/contributor-guide/feedback/reporting-issues#creating-a-new-issue-report) is for you. - -## Translate the Project -We accept translations through [Weblate](https://hosted.weblate.org/projects/rosp/atlas/). - -Alternatively, you can fork this repository, edit the `*.po` files directly, and submit changes through pull requests. - -## Propose Code Changes -We accept changes to the source code through pull requests. Even a small typo fix is welcome. - -We follow [the coding style by elementary](https://docs.elementary.io/develop/writing-apps/code-style). Try to respect them. - -> [!TIP] -> Again, [the guideline by elementary](https://docs.elementary.io/contributor-guide/development/prepare-code-for-review) would be helpful here too. diff --git a/README.md b/README.md index 7a06cdb..0177edf 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,18 @@ # Atlas -![App window in the light mode](data/screenshots/screenshot-light.png#gh-light-mode-only) +![Screenshot in the light mode](data/screenshots/screenshot-light.png#gh-light-mode-only) -![App window in the dark mode](data/screenshots/screenshot-dark.png#gh-dark-mode-only) +![Screenshot in the dark mode](data/screenshots/screenshot-dark.png#gh-dark-mode-only) -Atlas is a map viewer designed for elementary OS. +## Building, Testing, and Installation -Features include: - -- Search any place -- Jump to your current location instantly - -## Installation -### From AppCenter (Recommended) -Click the button to get Atlas on AppCenter if you're on elementary OS: - -[![Get it on AppCenter](https://appcenter.elementary.io/badge.svg)](https://appcenter.elementary.io/com.github.ryonakano.atlas) - -### From Source Code (Flatpak) -You'll need `flatpak` and `flatpak-builder` commands installed on your system. - -Run `flatpak remote-add` to add AppCenter remote for dependencies: - -``` -flatpak remote-add --user --if-not-exists appcenter https://flatpak.elementary.io/repo.flatpakrepo -``` - -To build and install, use `flatpak-builder`, then execute with `flatpak run`: - -``` -flatpak-builder builddir --user --install --force-clean --install-deps-from=appcenter com.github.ryonakano.atlas.yml -flatpak run com.github.ryonakano.atlas -``` - -### From Source Code (Native) -You'll need the following dependencies: - -* libadwaita-1-dev -* libgeoclue-2-dev -* libgeocode-glib-dev (>= 3.26.3) -* libglib2.0-dev (>= 2.74) -* libgranite-7-dev (>= 7.2.0) -* libgtk-4-dev -* libshumate-dev -* meson (>= 0.57.0) -* valac - -Run `meson setup` to configure the build environment and run `meson compile` to build: +Run `flatpak-builder` to configure the build environment, download dependencies, build, and install ```bash -meson setup builddir --prefix=/usr -meson compile -C builddir + flatpak-builder build com.github.ryonakano.atlas.yml --user --install --force-clean --install-deps-from=appcenter ``` -To install, use `meson install`, then execute with `com.github.ryonakano.atlas`: +Then execute with ```bash -meson install -C builddir -com.github.ryonakano.atlas + flatpak run com.github.ryonakano.atlas ``` - -## Contributing -Please refer to [the contribution guideline](CONTRIBUTING.md) if you would like to: - -- submit bug reports / feature requests -- propose coding changes -- translate the project - -## Get Support -Need help in use of the app? Refer to [the discussions page](https://github.com/ryonakano/atlas/discussions) to search for existing discussions or [start a new discussion](https://github.com/ryonakano/atlas/discussions/new/choose) if none is relevant. - -## History -This is a fork of [Atlas Maps](https://launchpad.net/atlas-maps) and wouldn't exist without work of [Steffen Schuhmann](https://launchpad.net/~sschuhmann). diff --git a/RELEASE_HOWTO.md b/RELEASE_HOWTO.md deleted file mode 100644 index 3034da7..0000000 --- a/RELEASE_HOWTO.md +++ /dev/null @@ -1,38 +0,0 @@ -# Release Flow -## Work in Project Repository -- Repository URL: https://github.com/ryonakano/atlas -- Decide the version number of the release - - Versioning should follow [Semantic Versioning](https://semver.org/) -- Create a new branch named `release-X.Y.Z` from latest `origin/main` (`X.Y.Z` is the version number) -- See changes since the previous release - ``` - $ git diff $(git describe --tags --abbrev=0)..release-X.Y.Z - ``` -- Update screenshots if there are visual changes between releases -- Create a pull request with the following changes and merge it once the build succeeds - - Write a release note in `data/atlas.metainfo.xml.in.in` - - Refer to [the Metainfo guidelines by Flathub](https://docs.flathub.org/docs/for-app-authors/metainfo-guidelines) - - Credits contributors with their GitHub username - - Bump `version` in `meson.build` - ```meson - project( - 'com.github.ryonakano.atlas', - 'vala', 'c', - version: '3.0.2', - meson_version: '>=0.58.0' - ) - ``` -- [Create a new release on GitHub](https://github.com/ryonakano/atlas/releases/new) - - Create a new tag named `X.Y.Z` - - Release title: ` X.Y.Z Released` - - Publish it when completed - -## Work in AppCenter Review Repository -- Repository URL: https://github.com/elementary/appcenter-reviews -- Fork the repository if you don't have write access to it -- Create a new branch named `com.github.ryonakano.atlas-X.Y.Z` from latest `origin/main` -- Create a pull request with the following changes and await for review approval and merge - - Change `commit` and `version` in the `applications/com.github.ryonakano.atlas.json` - - `commit` should be the release commit just we published on the project repository - - `version` for the relase version -- The new release should be available on AppCenter after some time From 3085478a74476949b179ff6e3503c12ddf0b0262 Mon Sep 17 00:00:00 2001 From: Ryo Nakano Date: Wed, 9 Jul 2025 21:47:59 +0900 Subject: [PATCH 2/2] [skip ci] Update README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0177edf..d1fd92d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ ![Screenshot in the dark mode](data/screenshots/screenshot-dark.png#gh-dark-mode-only) ## Building, Testing, and Installation - Run `flatpak-builder` to configure the build environment, download dependencies, build, and install ```bash @@ -16,3 +15,6 @@ Then execute with ```bash flatpak run com.github.ryonakano.atlas ``` + +## History +This is a fork of [Atlas Maps](https://launchpad.net/atlas-maps) and wouldn't exist without work of [Steffen Schuhmann](https://launchpad.net/~sschuhmann).