Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
**/*.exe
!new-*/**/*.vbs
!new-*/**/*.bat
!new-*/**/*.yaml
!new-*/**/*.ps1
!new-*/**/*.ico
!new-*/**/*.png
!new-*/**/*.jpg
!new-*/**/*.jpeg
!new-*/**/*.bmp
!new-*/**/*.txt
90 changes: 90 additions & 0 deletions How to create installer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
Windows Installer
==================
These are instructions to create installer for Osdag version 2026.02.0.0 and above for Windows.

## 1. Prepare Build Environment
Create and activate a clean build environment:
```
conda create -n bld-env python=3.12
conda activate bld-env
conda install constructor -c conda-forge

```
## 2. Ensure Osdag Conda Package Exists
Before building the installer:
- Build the Osdag conda package.
- Upload it to osdag-admin conda channel.
- Confirm the correct version is available:
```
conda search osdag -c osdag
```

## 3. Project Structure
Constructor project directory(new-constructor-installer) should contains:
```
constructor-installer/
├── construct.yaml
├── license.txt
├── Osdag.ico
├── post_install.bat
├── pre_uninstall.bat
├── create_shortcuts.ps1
├── remove_shortcuts.ps1
├── launch_osdag.vbs
```
No need to manually bundle anything, Constructor resolves and bundles everything from conda packages automatically.

## 4. Build Installer
Activate environment, go to Contructor project drectory and run constructor
```
conda activate bld-env
cd \path\to\WindowsInstaller\new-contructor-installer
constructor .
```
The .exe installer will be created in the current directory.

## 5. Customizing Installer UI (Removing Default Header/Welcome Image)
Constructor internally generates an NSIS script from:
```
<conda_env>\Lib\site-packages\constructor\nsis\main.nsi.tmpl
```
If you want to remove the default welcome and header images:
#### 1. Open
```
<conda_env>\Lib\site-packages\constructor\nsis\main.nsi.tmpl
```
#### 2. Comment out lines:
- 197–199
- 197–199
These correspond to default welcome/header image definitions.
#### 3. Save the file.
#### 4. Save the file.
```
constructor .
```
## 6. Shortcut and Registry Management
Shortcuts and uninstall entries are handled via:
- `post_install.bat`
- `pre_uninstall.bat`
- `create_shortcuts.ps1`
- `remove_shortcuts.ps1`

All-users installs use HKLM (64-bit registry view). All-users installs use HKLM (64-bit registry view).

## 7 What Is No Longer Required
The following legacy steps are removed:

- ❌ Manual Miniconda bundling
- ❌ Manual dependency copying
- ❌ Manual LaTeX packaging
- ❌ PyInstaller wrapping of installer components
- ❌ Writing full NSIS script manually

## 8. Summary
Old workflow:
`Manual NSIS + Miniconda + dependency packaging + source bundling.`
New workflow:
`Conda package → Constructor → Installer.`

Cleaner. Reproducible. Maintainable.
45 changes: 0 additions & 45 deletions How to create installer.txt

This file was deleted.

134 changes: 134 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
# Windows Installer

This installer installs **Osdag** along with all required runtime
dependencies using a constructor-based bundled Conda environment.

Unlike earlier versions, this installer does **not** separately install
Miniconda or MiKTeX through manual steps. All required dependencies are
bundled and configured automatically.

------------------------------------------------------------------------

## System Requirements

### Supported Windows Operating Systems

- Windows 10\
- Windows 11

> Older versions (Vista, 7, 8, 8.1) are no longer officially supported.

### Supported Architecture

- 64-bit only

### RAM and Storage

- **Minimum RAM:** 4 GB
- **Recommended RAM:** 8 GB or higher
- **Minimum Disk Space:** 12 GB

------------------------------------------------------------------------

## Uninstalling Earlier Versions of Osdag

If a previous version of Osdag is installed, it is strongly recommended
to uninstall it before installing a new version.

### Method 1 (Recommended)

1. Open **Control Panel → Programs and Features**
2. Select **Osdag**
3. Click **Uninstall**

### Method 2

1. Navigate to the installation directory

2. Run:

Uninstall-Osdag.exe

------------------------------------------------------------------------

## Installation Steps

1. Download the installer:

Osdag-<Version>-Windows-x86_64.exe

2. Double-click the installer to start installation.

3. Follow the on-screen instructions:

- Click **Next**
- Read and accept the license agreement
- Choose installation scope:
- *Just Me* (recommended)
- *All Users* (requires administrator privileges)
- Select installation directory
- Click **Install**

4. Wait for installation to complete.

> Installation may take several minutes as the Conda environment is
> being configured.

5. Click **Finish** once installation completes.

------------------------------------------------------------------------

## What Happens During Installation

The installer automatically:

- Creates a dedicated Conda runtime environment
- Installs Osdag and its dependencies
- Configures required Python packages
- Sets up shortcuts (if selected) via post_install script
- Registers Osdag in Windows Programs and Features


------------------------------------------------------------------------

## Running Osdag

After installation, Osdag can be launched using any of the following
methods:

1. Double-click the **Desktop shortcut**

2. Press the **Windows key** and search for `Osdag`

3. Navigate to the installation directory and run:

Osdag.exe

------------------------------------------------------------------------

## Notes

- For system-wide installation, administrative privileges are
required.
- The installer automatically handles registry entries and
uninstallation metadata.
- The installed size is visible in **Control Panel → Programs and
Features**.

------------------------------------------------------------------------

## Troubleshooting

If installation fails:

1. Ensure sufficient disk space is available.
2. Run the installer as Administrator (for All Users install).
3. Temporarily disable antivirus software if it interferes with
execution.

------------------------------------------------------------------------

## Contact

For support and updates:\
https://osdag.fossee.in
63 changes: 0 additions & 63 deletions README.txt

This file was deleted.

Loading