Merge pull request #204 from sunnamed434/updates

Updates

Author: sunnamed434

.readthedocs.yaml

@@ -10,4 +10,9 @@ python:
     - requirements: docs/requirements.txt
 
 sphinx:
-  configuration: docs/source/conf.py
+  configuration: docs/source/conf.py
+
+formats:
+  - pdf
+  - epub
+  - html

README.md

@@ -88,13 +88,24 @@ Read the **[docs][bitmono_docs]** to read protection, functionality, and more.
 
 ### Download
 
-Go and get [Latest BitMono Release][bitmono_latest_release] and download preferred archive file, and make sure to select the similar or same Target Framework of the app that you are going to protect, for example:
-
-- Your Target File is for .NET 8 then use BitMono for .NET 8 `BitMono-v0.25.3+e64e54d3-CLI-net8.0-win-x64.zip`
-- Your Target File is for .netstandard then use BitMono for .NET Framework or .NET 8 `BitMono-v0.25.3+e64e54d3-CLI-net8.0-win-x64.zip`
-- Your Target File is .NET Framework then use BitMono for .NET Framework `BitMono-v0.25.3+e64e54d3-CLI-net462-win-x64.zip`
-
-If you select wrong BitMono build you have a risk that your file going to be protected incorrectly, because you use different target framework build.
+To download the latest release of BitMono, follow these steps:
+
+1. Go to the [Latest BitMono Release][bitmono_latest_release].
+2. Select and download the archive file that matches the Target Framework of the application you want to protect. Here are some examples:
+
+- **Targeting .NET 8**: If your target file is built for .NET 8, download:  
+  `BitMono-v0.25.3+e64e54d3-CLI-net8.0-win-x64.zip`
+  
+- **Targeting .NET Standard**: If your target file is built for .NET Standard, you can use either BitMono for .NET Framework or .NET 8:  
+  `BitMono-v0.25.3+e64e54d3-CLI-net8.0-win-x64.zip`
+  
+- **Targeting .NET Framework**: If your target file is built for .NET Framework, download:  
+  `BitMono-v0.25.3+e64e54d3-CLI-net462-win-x64.zip`
+  
+- **Targeting Mono or Unity Engine Runtime**: If your target file is built for .NET Framework and runs on Mono or Unity, use the .NET Framework version:  
+  `BitMono-v0.25.3+e64e54d3-CLI-net462-win-x64.zip`
+
+> **Note:** Be sure to select the correct version of BitMono that matches your Target Framework. Using the wrong version could result in compatibility issues.
 
 ### Pre-Require
 

docs/.env

@@ -0,0 +1 @@
+COMPOSE_PROJECT_NAME=bitmono-docs-project

docs/.gitignore

@@ -0,0 +1,19 @@
+# Use a base image with Python
+FROM python:3.10-slim
+
+# Set working directory
+WORKDIR /docs
+
+# Copy the documentation source into the container
+COPY . /docs
+
+# Install Sphinx and build the documentation
+RUN pip install sphinx sphinx-rtd-theme
+RUN sphinx-build -b html source build
+
+# Expose the port the app runs on
+EXPOSE 8000
+
+# Command to run the HTTP server and output instructions
+CMD echo "Documentation is available at http://localhost:8000" && \
+    python -m http.server 8000 --directory build

docs/Dockerfile

@@ -0,0 +1,23 @@
+How to Run BitMono Docs Locally
+
+Prerequisites:
+- Ensure Docker is installed on your machine. If not, install Docker from https://docs.docker.com/get-docker/.
+
+Running Locally:
+1. Start Docker if it’s not already running.
+2. Open a terminal and navigate to the directory containing your docker-compose.yml file.
+3. Execute the following command to build and start the container:
+   docker-compose up --build
+4. Open your browser and go to: http://localhost:8000 to view the documentation.
+
+Restarting the Container:
+1. To stop the container, press CTRL + C in the terminal where Docker is running, or close the terminal window.
+2. To restart the container and apply any changes, execute:
+   docker-compose up --build
+3. Refresh the browser page at http://localhost:8000 to see the latest updates.
+
+To edit/update docs:
+Prerequisites:
+- Use Visual Studio Code, or any other tool. https://code.visualstudio.com/
+
+Go to `source` folder and do your magic!

docs/README.txt

@@ -0,0 +1,9 @@
+services:
+  docs:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    image: bitmono-docs-image:latest
+    ports:
+      - "8000:8000"
+    entrypoint: ["sh", "-c", "echo 'Documentation is available at http://localhost:8000' && python -m http.server 8000 --directory build"]

docs/docker-compose.yml

@@ -57,6 +57,7 @@ Table of Contents:
    obfuscationissues/corlib-not-found
    obfuscationissues/intended-for
    obfuscationissues/compatibility
+   obfuscationissues/ready-to-run
 
 
 .. toctree::

docs/source/index.rst

@@ -1,17 +1,39 @@
 The module is built for ...
 ===========================
 
-`The module is built for .NET (Core), but you're using a version of BitMono intended for .NET Framework.` - this message is very important because if your app is built on .NET Core but BitMono on .NET Framework after obfuscation your app just won't work.
+Understanding Compatibility
+---------------------------
 
-Examples
---------
+When using BitMono for obfuscation, it's critical to ensure that the version of BitMono matches the framework your application is built on. 
 
-Good:
+For example, if your application is built on .NET Core, you **must** use the version of BitMono that is also built for .NET Core. Using an incompatible version will result in your application not functioning after obfuscation.
 
-- BitMono on .NET Core and your app on .NET Core
-- BitMono on .NET Framework and your app on .NET Framework
+.. note:: 
+   A common error message you may encounter is:  
+   ``The module is built for .NET (Core), but you're using a version of BitMono intended for .NET Framework.``
+   This indicates a mismatch between your app's framework and BitMono's version.
 
-Bad (IT WON'T WORK!!!):
+Examples of Compatibility
+--------------------------
 
-- BitMono on .NET Core and your app on .NET Framework
-- BitMono on .NET Framework and your app on .NET Core
+Here are some examples of correct and incorrect configurations:
+
+**✅ Good Configurations:**
+
+- **BitMono for .NET Core** with an application built on **.NET Core**
+- **BitMono for .NET Framework** with an application built on **.NET Framework**
+
+**❌ Bad Configurations (These Won't Work!):**
+
+- **BitMono for .NET Core** with an application built on **.NET Framework**
+- **BitMono for .NET Framework** with an application built on **.NET Core**
+
+Key Takeaways
+-------------
+
+- Always ensure that **BitMono's framework version** matches the **framework version** of your application.
+- Incompatible configurations will break your app after obfuscation.
+- Carefully check the framework version of both your app and the BitMono release you are using.
+
+.. warning:: 
+   Mixing framework versions (e.g., using BitMono for .NET Framework with a .NET Core app) will cause the app to fail after obfuscation.

docs/source/obfuscationissues/compatibility.rst

@@ -0,0 +1,38 @@
+ReadyToRun
+==========
+
+If you're encountering an error from BitMono regarding ReadyToRun, or your application is built using ReadyToRun, it means that your application is "protected" by being compiled into native code. However, BitMono cannot obfuscate it because it requires "managed" code.
+
+To solve this issue, you can do the following:
+
+Disable ReadyToRun
+------------------
+
+Simply go to your `.csproj` file, add the `PublishReadyToRun` option and set it to `false`. This will look like the following:
+
+.. code-block:: xml
+
+    <Project Sdk="Microsoft.NET.Sdk">
+        <PropertyGroup>
+            <OutputType>Exe</OutputType>
+            <TargetFramework>net8.0</TargetFramework>
+            <ImplicitUsings>enable</ImplicitUsings>
+            <Nullable>enable</Nullable>
+            <PublishReadyToRun>false</PublishReadyToRun> <!-- Add this option and set to false -->
+        </PropertyGroup>
+    </Project>
+
+
+Now, build the project and use `.dll` file that has a managed code, instead of native code.
+
+`For more information, visit: <https://learn.microsoft.com/en-us/dotnet/core/deploying/ready-to-run>`_
+
+Use .dll File with Managed Code Instead of .exe File
+----------------------------------------------------
+
+Usually, in the output folder of your project (if it's a `.exe`), there should be a `.dll` file with managed code. Use this `.dll` file for obfuscation instead, if there's no such file or it has a native code then use upper solution.
+
+Didn't Help?
+------------
+
+If none of the solutions worked, it likely means your file is either protected or broken. If this isn't the case, please open an issue on the BitMono GitHub repository or reach out to us on Discord for further assistance.