THE WRITER’S COMPANION
LINUX INSTALLATION GUIDE
========================

This guide explains how to install The Writer’s Companion on a Linux computer.

1. BEFORE YOU BEGIN
-------------------
The Writer’s Companion is a free, standalone application made for Linux.

Download the ZIP package named:
    writers_companion_v1.0.zip

Save it in your Downloads folder before continuing.

2. OPEN A TERMINAL
------------------
Open Terminal from your Linux applications menu. On many Linux desktops,
Ctrl+Alt+T opens a terminal.

3. INSTALL THE APPLICATION
--------------------------
Copy and paste this complete command into the terminal, then press Enter:

cd "$HOME/Downloads" &&
rm -rf writers_companion_v1.0 &&
mkdir -p writers_companion_v1.0 &&
unzip -o writers_companion_v1.0.zip -d writers_companion_v1.0 &&
cd writers_companion_v1.0 &&
chmod +x install.sh &&
./install.sh

The command changes to Downloads, extracts the ZIP into a working folder,
makes the installer executable, and runs it. Wait for the installer to finish.

If Linux says that “unzip” is not installed, install the unzip package using
your distribution’s software manager and run the command again.

4. START THE APPLICATION
------------------------
Use the application launcher if the installer creates one. Otherwise, try:

python3 "$HOME/Documents/Writers_Companion_App/electronic_typewriter.py"

If Linux says the file cannot be found, check the installation folder listed
at the end of this guide and follow any path reported by the installer.

5. USING THE WRITER’S COMPANION
-------------------------------
- New: start a new document.
- Open…: open an existing document.
- Save: save your work.
- Save and Quit: save and close the application.
- Use the controls to select paper size, typewriter model, typeface size,
  line spacing, and margins.
- The page count shown in the bottom status line is an estimate. It does not
  insert page numbers into your writing and is not an exact print preview.

6. TROUBLESHOOTING
------------------
- Confirm that writers_companion_v1.0.zip is in ~/Downloads.
- Check that the filename in the command matches the downloaded ZIP.
- Run the complete command block in a terminal.
- Read any error message carefully. Do not delete your documents folder as
  an installation troubleshooting step.
- If you need help, copy the terminal error message so it can be examined.

WHERE EVERYTHING IS INSTALLED
==============================

The tilde character (~) means your personal home folder, usually something
like /home/your-user-name.

Downloaded ZIP:
    ~/Downloads/writers_companion_v1.0.zip

Extracted installation package:
    ~/Downloads/writers_companion_v1.0/

Installer script:
    ~/Downloads/writers_companion_v1.0/install.sh

Application installation folder:
    ~/Documents/Writers_Companion_App/

Expected main application file:
    ~/Documents/Writers_Companion_App/electronic_typewriter.py

Default folder for your writing documents:
    ~/Documents/Writers_Companion/

Help/manual files:
    The installation package includes help material. The installer may copy
    the manual into the application installation folder; check that folder
    for the installed copy.

Recovery snapshots, backups, and settings:
    These are managed by the application. Their exact locations can vary by
    version or configuration, so consult the application’s help or inspect
    the installed files if you need the precise subfolder.

IMPORTANT
---------
The extracted folder in Downloads contains the installation package. It is
not your normal writing folder. Your documents are intended to be stored in:

    ~/Documents/Writers_Companion/

The paths above reflect the project’s configured locations. If the installer
prints different paths or creates a launcher, follow the messages shown by
your installation.