From 4bf0a929f6d75c8a926050d3cd29e146851bb8f4 Mon Sep 17 00:00:00 2001 From: Michael Becker Date: Sat, 15 May 2021 01:08:27 -0400 Subject: [PATCH] update README with disclaimer and other stuff --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 22bf1d82..564e51fb 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,13 @@ TL;DR - Tested Working on Ubuntu 20.10 * Run ./firstrun.sh to fetch dependencies and related projects. * Type ./universal-editor to run the program in Debug mode from the repository folder. +Disclaimer +---------- +Despite the version numbering, Universal Editor is far from ready-to-use in a production environment. There are plenty of areas of messy code that need cleaning up, and lots of scaffolding for functionality that is nowhere near complete. This is a free software project, maintained in the authors' free time and leisure. While this project strives to be a shining example of just how powerful and cross-platform .NET technology can be, please take issues with a grain of salt. Don't hesitate to open issues on the project page, but please be patient as the authors attempt to find time to fix bugs, polish existing features, and expand further development. + Philosophy ---------- -UniversalEditor 4 has four components: +UniversalEditor has four components: * *Editor* is responsible for modifying the content of the ObjectModel from a user's point of view. * *ObjectModel* contains the user-friendly, DataFormat-agnostic representation of the data. @@ -26,14 +30,15 @@ Prerequisites * MBS.Framework * MBS.Rendering (if building Multimedia3D plugin) * MBS.Framework.UserInterface (if building UserInterface) +* MBS.Audio (if building Multimedia plugin with user interface) Building -------- The solution and dependencies need to be cleaned up before we can write a proper tutorial for building. Keep everything in the same parent directory, *git clone* alcexhim/UniversalEditor, alcexhim/MBS.Framework, and alcexhim/MBS.Framework.UserInterface. For 3D rendering support it is also necessary to clone alcexhim/MBS.Framework.Rendering as well as the appropriate rendering engine (e.g. MBS.Framework.Rendering.Engines.OpenGL). -In a terminal window, navigate to the UniversalEditor directory that you just cloned, type "msbuild" (or "MSBuild.exe" on Windows), and press ENTER. This should take care of compiling UniversalEditor and any associated dependencies. +In a terminal window, navigate to the UniversalEditor directory that you just cloned, type `msbuild` (or `MSBuild.exe` on Windows), and press ENTER. This should take care of compiling UniversalEditor and any associated dependencies. -The application *WILL NOT* work properly if the appropriate Universal Widget Toolkit engine, MBS.Framework.UserInterface.(engine).dll, is not in the Output/(configuration) directory! The build process at this time does not automatically copy this file from the MBS.Framework.UserInterface output directory to the Universal Editor output directory. You may use the uwt-install-gtk.sh and uwt-install-wf.sh scripts (in bash) to do this. +The application *WILL NOT* work properly if the appropriate Universal Widget Toolkit engine, MBS.Framework.UserInterface.(engine).dll, is not in the Output/(configuration) directory! The build process at this time does not automatically copy this file from the MBS.Framework.UserInterface output directory to the Universal Editor output directory. You may use the fxtool script (in bash) to do this: `fxtool install gtk` or `fxtool install wf`. Currently the most up-to-date User Interface Engine is GTK, but I have made a lot of progress in bringing the Windows Forms one up to par. You might find that the GTK engine only works on Linux. I can't offer any help or support for getting the GTK engine to work on a different operating system. You should be able to use the Windows Forms engine on the latest version of Windows with minimal trouble.