readme

README.md

@@ -2,7 +2,7 @@
 
 > 🚧 Work in progress
 
-A small rust utility to sort a modlist topologically according to ordering rules, as wall as output warnings and notes.
+A small rust utility to sort a modlist topologically according to ordering rules, as wall as output warnings and notes. Includes a GUI app and a commandline tool.
 
 Supported games:
 
@@ -37,6 +37,19 @@ The rules are hosted in their own repository:
 2. Place `plox.exe` next to the game's exe
 3. Open a terminal window and run `plox.exe` with a command
 
+## Screenshots
+
+![Screenshot](/assets/Screenshot_gui.png)
+![Screenshot](/assets/Screenshot_cli.png)
+
+## Credits
+
+- [MLOX](https://github.com/mlox/mlox)
+- [MLOX Rules](https://github.com/DanaePlays/mlox-rules)
+- [OpenMw Cfg Crate](https://gitlab.com/bmwinger/openmw-cfg)
+
+## CLI Commands
+
 ```txt
 Usage: plox.exe [OPTIONS] <COMMAND>
 

gui/src/app.rs

@@ -167,6 +167,9 @@ impl eframe::App for TemplateApp {
                 let is_web = cfg!(target_arch = "wasm32");
                 if !is_web {
                     ui.menu_button("File", |ui| {
+                        ui.hyperlink_to("PLOX on GitHub", "https://github.com/rfuzzo/plox");
+
+                        ui.separator();
                         if ui.button("Quit").clicked() {
                             ctx.send_viewport_cmd(egui::ViewportCommand::Close);
                         }
@@ -285,7 +288,11 @@ impl eframe::App for TemplateApp {
         // main panel
         egui::CentralPanel::default().show(ctx, |ui| {
             // The central panel the region left after adding TopPanel's and SidePanel's
-            ui.heading("PLOX");
+            ui.heading(format!(
+                "PLOX v{} - {:?}",
+                crate::CARGO_PKG_VERSION,
+                data.game
+            ));
 
             // filters
             ui.horizontal(|ui| {

gui/src/lib.rs

@@ -12,6 +12,8 @@ use plox::{
     sorter::new_stable_sorter,
 };
 
+const CARGO_PKG_VERSION: &str = env!("CARGO_PKG_VERSION");
+
 #[derive(serde::Deserialize, serde::Serialize, Debug, PartialEq)]
 enum ETheme {
     Dark,