Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 0 additions & 22 deletions CONTRIBUTING.md

This file was deleted.

67 changes: 7 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,20 @@
# 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.

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.3.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:
## Building, Testing, and Installation
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).
38 changes: 0 additions & 38 deletions RELEASE_HOWTO.md

This file was deleted.