diff --git a/COPYING b/LICENSE similarity index 100% rename from COPYING rename to LICENSE diff --git a/README.md b/README.md index d11a990..6cde436 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ -# gnomeframe +# Gnomeframe -A description of this project. +This is a companion-app for Warframe players on Linux, written in phython and GTK4/ADW with the help of [GNOME Builder](https://apps.gnome.org/Builder/) and [PyGObject](https://pygobject.gnome.org/). + +## Features + +- Manage a persistent list of which Basic and Prime warframes you own to help you plan what to get next! + +## Planned + +- Overview of needed parts, with ability to select which are already acquired, what is needed to craft them, and where/how to optain them. +- Overview of which frames have been subsumed. +- Overview of which relics to prioritize based on which frames are missing or a wishlist of priority frames. (Potentially also integrate market data?) +- Support for weapons. + +## Building + +Ideally, cloning the repo and opening with GNOME Builder will have the best results since that is the development environment I am using. + git clone https://git.valhrafnaz.gay/valhrafnaz/Gnomeframe.git + +Alternatively, you can run ninja yourself. + +## License + +This project is licensed under the AGPL-v3. Please refer to the [LICENSE].