README.md
1<h1 align="center">
2 <br>
3 <img src="akira-logo-transparent.png" alt="Akira">
4</h1>
5<h4 align="center">The UI/UX Design Tool</h4>
6<p align="center">
7 <a href="https://github.com/akiraux/Akira/actions"><img src="https://github.com/akiraux/Akira/workflows/CI/badge.svg"
8 alt="Build Status"></a>
9 <a href="https://liberapay.com/AkiraUX"><img
10 src="http://img.shields.io/liberapay/patrons/AkiraUX.svg?logo=liberapay" alt="AkiraUX on Liberapay"></a>
11 <a href="https://www.patreon.com/akiraux"><img
12 src="https://img.shields.io/badge/patreon-donate-orange.svg?logo=patreon" alt="AkiraUX on Patreon"></a>
13</p>
14<p align="center">
15 <a href="#-install">Install</a> •
16 <a href="#-compile">Compile</a> •
17 <a href="#-questions">Questions</a> •
18 <a href="#-contributing">Contributing</a> •
19 <a href="#-support">Support</a> •
20 <a href="#-mascot">Mascot</a> •
21 <a href="#-license">License</a>
22</p>
23
24
25
26Akira is a native Linux Design application built in Vala and GTK. Akira focuses on offering a modern and fast approach to UI and UX Design, mainly targeting web designers and graphic designers. The main goal is to offer a valid and professional solution for designers who want to use Linux as their main OS.
27
28⚠️⚠️ **AKIRA IS CURRENTLY IN EARLY DEVELOPMENT, NOT READY TO BE USED FOR PRODUCTION!** ⚠️⚠️
29
30Feel free to download the Alpha and help us testing it.
31
32## �� Install
33
34| elementaryOS AppCenter | FlatHub |
35|------------------------ |--------------- |
36|[](https://appcenter.elementary.io/com.github.akiraux.akira/)|<a href="#flathub-beta"><img src="https://flathub.org/assets/badges/flathub-badge-i-en.svg" width="160px" alt="Get it from Flathub!"></a>
37
38### Flathub Beta
39```
40flatpak remote-add flathub-beta https://flathub.org/beta-repo/flathub-beta.flatpakrepo
41flatpak install akira
42```
43
44## �� Compile
45
46You can install Akira by compiling it from the source
47
48### Install Dependencies
49
50 - `gtk+-3.0>=3.18`
51 - `granite>=6.0.0`
52 - `glib-2.0`
53 - `gee-0.8`
54 - `gobject-2.0`
55 - `libxml-2.0`
56 - `libjson-glib-1.0`
57 - `goocanvas-3.0`
58 - `libarchive`
59 - `gettext`
60 - `cairo`
61 - `meson`
62
63> _**Note:** For non-elementary distros, (such as Arch, Debian etc) you are required to install "vala", "elementary-theme" and "elementary-icon-theme" as additional dependencies._
64
65### Compile & Run
66
67Once the above mentioned dependencies are resolved, Akira can be compiled & installed
68
69```sh
70meson build --prefix=/usr -Dprofile=default
71cd build
72ninja && sudo ninja install
73```
74
75> _**Note:** Replace the `-Dprofile=default` with `-Dprofile=development` to compile and install Akira in **development** mode where you can make changes._
76
77## �� Questions
78
79If you want to ask any questions about the project, join us on our public Matrix channel at
80[#akiraux:matrix.org](https://matrix.to/#/#akiraux:matrix.org) or on IRC at #akiraux on LiberaChat.
81
82We also have a dedicated Discord channel available to any [Patreon](https://www.patreon.com/akiraux) supporters where we offer more direct support, and we're open to discussing new features and implementations.
83
84If you are trying out Akira and you encounter an error or any problem feel free to just open an issue here on GitHub.
85
86## ���� Contributing
87
88Feel free to send a pull request to this repository with your code contributions, but first read our [contributing guidelines](CONTRIBUTING.md) :page_with_curl:
89
90## �� Code of Conduct
91
92This project adheres to the adapted version of Contributor Covenant [code of conduct](.github/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
93
94## �� Support
95
96If you like Akira and you want to support its development, consider donating via [Liberapay](https://liberapay.com/AkiraUX/) or pledge on [Patreon](https://www.patreon.com/akiraux).
97
98## ✨ Mascot
99
100
101
102**Akari the Cyber Phoenix** is a perfectionist. She is tidy, collected and has a sharp eye for detail. Her name Akari (灯理、) means *"the enlightenment of a sophisticated order"*. Her costume resembles the project's icon. Get the Mascot and all the other assets from [here](https://github.com/akiraux/assets).
103
104Mascot character designed by **Tyson Tan**.
105Tyson Tan offers mascot design service for free and open source software, free of charge, under free license.
106Contact: [http://tysontan.com](http://tysontan.com) / [tysontan@mail.com](mailto:tysontan@mail.com)
107
108## �� License
109#### [GNU GPLv3 / Creative Commons BY-SA](./COPYING)
110
111Copyright © 2019-2020 Akira Project.
112
){kind=link}
){kind=link}