aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--cleanup.md26
1 files changed, 24 insertions, 2 deletions
diff --git a/cleanup.md b/cleanup.md
index d3b3034..f259eba 100644
--- a/cleanup.md
+++ b/cleanup.md
@@ -1,7 +1,29 @@
Cleanup
=======
-This branch is the refactored and rewritten code of ShiftOS designed to be better maintainable.
+This branch is home to the fresh refactored and rewritten code of ShiftOS, aiming to be more maintainable.
+
+Please don't double-push stuff both in master and this branch, I will take care of it and make sure it doesn't break stuff on my end.
"Lead developer" of this branch: AlphaBeta0110
-Please don't double-push stuff both in master and this branch, I will take care of it.
+Why?
+----
+The ShiftOS code is literally messed to the point it's hard to make a change in some of the more used code, like window code, as it's repeated and repeated in almost every file.
+Refactoring and rewritting the code will result in a code that is better maintainable and where it isn't required one constant manually in all files to change something.
+
+
+Roadmap
+-------
+1. Rewrite and refactoring of the windows code - IN PROGRESS
+2. Replace hard coded paths
+2. Rewrite the skinning code to be more self-describing
+3. Rewrite the code behind Shiftorium and Installer and moving it to API classes the applications will use
+4. Document the API
+5. Make ShiftOS modular, which makes mods possible
+
+Current status
+--------------
+* ShiftOS.API.ShiftWindow - 40% done
+* Modifying all windows to use the ShiftWindow API - 0% done
+* Making custom classes for buttons and other common controls - 0% done
+* Did I mention documentation? Documentation - 0% done \ No newline at end of file