Reorganize files a bit; Add READMEs to all crate

funlennysub · Oct 16, 2022 · 807efe8 · 807efe8
1 parent fce10a5
commit 807efe8
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 6 deletions.
diff --git a/bepinex_helpers/README.md b/bepinex_helpers/README.md
@@ -0,0 +1,2 @@
+# bepinex_helpers
+Different structs and function meant to be used by other tools in a repo
diff --git a/bepinex_installer/README.md b/bepinex_installer/README.md
@@ -0,0 +1,9 @@
+# BepInEx Installer
+
+## Features
+| Name                     | Description             | Status |
+| ------------------------ | ----------------------- | :----: |
+| Stable Releases          | Install stable releases |   ✔    |
+| BE Releases              | Install BE releases     |   ❌    |
+| Better UI                | Make UI look pretty     |   👷‍♀️    |
+| Support other game types | Support for .NET games  |   ❌    |
diff --git a/bepinex_installer/src/installer.rs b/bepinex_installer/src/installer.rs
@@ -1,9 +1,7 @@
 use std::time::Duration;
 
 use bepinex_helpers::game::{Game, GameType};
-use bepinex_sources::models::bleeding_edge::bepinex::{
-    AssetDownloader, BepInEx, BepInExRelease, ReleaseFlavor,
-};
+use bepinex_sources::bepinex::{AssetDownloader, BepInEx, BepInExRelease, ReleaseFlavor};
 use eframe::{
     egui::{
         Button, CentralPanel, ComboBox, Direction, FontFamily::Proportional, FontId, RichText,

diff --git a/bepinex_installer/src/main.rs b/bepinex_installer/src/main.rs
@@ -4,8 +4,8 @@ pub mod installer;
 
 use bepinex_helpers::game::get_unity_games;
 use bepinex_sources::{
+    bepinex::{BepInEx, BepInExRelease},
     github::GitHubApi,
-    models::bleeding_edge::bepinex::{BepInEx, BepInExRelease},
 };
 use eframe::{egui, run_native, NativeOptions};
 use lazy_static::lazy_static;

diff --git a/bepinex_sources/README.md b/bepinex_sources/README.md
@@ -0,0 +1,8 @@
+# bepinex_sources
+Crate for working with different BepInEx sources such as [Bleeding edge builds](https://builds.bepinex.dev/projects/bepinex_be) and [Stable builds](https://github.com/BepInEx/BepInEx/releases)
+
+## Features
+| Source             | Access all releases | Download specific release | Filter out releases | SourceRelease type into general type |
+| ------------------ | :-----------------: | ------------------------- | ------------------- | ------------------------------------ |
+| github.com         |          ✔          | ✔                         | ✔                   | ✔                                    |
+| builds.bepinex.dev |          ❌          | ❌                         | ❌                   | ❌                                    |
diff --git a/bepinex_sources/examples/basic.rs b/bepinex_sources/examples/basic.rs
@@ -1,4 +1,4 @@
-use bepinex_sources::{github::GitHubApi, models::bleeding_edge::bepinex::BepInExRelease};
+use bepinex_sources::{bepinex::BepInExRelease, github::GitHubApi};
 use semver::Version;
 
 fn main() -> anyhow::Result<()> {

diff --git a/...urces/src/models/bleeding_edge/bepinex.rs → bepinex_sources/src/bepinex.rs b/...urces/src/models/bleeding_edge/bepinex.rs → bepinex_sources/src/bepinex.rs
diff --git a/bepinex_sources/src/lib.rs b/bepinex_sources/src/lib.rs
@@ -1,2 +1,3 @@
+pub mod bepinex;
 pub mod github;
 pub mod models;
diff --git a/bepinex_sources/src/models/bleeding_edge/mod.rs b/bepinex_sources/src/models/bleeding_edge/mod.rs
@@ -1 +0,0 @@
-pub mod bepinex;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# bepinex_helpers
		Different structs and function meant to be used by other tools in a repo