Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
kent-rasmussen committed Nov 1, 2021
1 parent 175d80f commit 120bad5
Show file tree
Hide file tree
Showing 12 changed files with 11 additions and 14 deletions.
13 changes: 5 additions & 8 deletions FINDERRORLOGS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,13 @@
A→Z+T creates two kinds of logs:
- Each time you **run** A→Z+T, it logs information for that **run** to a file named `log_<date>.text`, where <date> is Year-Month-Day, e.g., "log_2021-10-05.txt" for a file created on October 5, 2021.
This is overwritten each time A→Z+T runs on that day, so if you need to keep it, e.g., to send it to me, to report behavior that did not cause an exception (below), **rename it before starting A→Z+T again**.
- Each time A→Z+T has an **exception** (a serious problem with the program, which causes it to exit, not just unexpected behavior),
it will compress the above log and name it `log_<dateTime>.xz`, where <dateTime> is Year-Month-DayTHour-Minute-Second,
e.g., "log_2021-09-25T11-49-27Z.xz" for a file made on September 25, 2021, at 11:49:27. This enables A→Z+T to easily save the log of each exception,
as compressed text files ready to [Email to me](BUGS.md). Any time you get one of these, please send it to me; this is the best way I can help you get moving again when you have a problem.
- Each time A→Z+T has an **exception** (a serious problem with the program, which causes it to exit, not just unexpected behavior), it will compress the above log and name it `log_<dateTime>.xz`, where <dateTime> is Year-Month-DayTHour-Minute-Second, e.g., "log_2021-09-25T11-49-27Z.xz" for a file made on September 25, 2021, at 11:49:27. This enables A→Z+T to easily save the log of each exception, as compressed text files ready to [Email to me](BUGS.md). Any time you get one of these, please send it to me; this is the best way I can help you get moving again when you have a problem.

## Finding the A→Z+T logs
The trickiest part of getting me the information I need to help you is finding where your system is putting A→Z+T logs.
They should be going into your working directory, which means the directory from which you launched python.
The trickiest part of getting me the information I need to help you is finding where your system is putting A→Z+T logs.
They should be going into your working directory, which means the directory from which you launched python.
If you launch python via clicking a link to main.py, the location of your logs may depend on how your operating system is configured. I recommend

- Looking in the same directory/folder as main.py (i.e., the A→Z+T repository copy on your computer)
- Looking in that repository's parent (the directory/folder which contains that directory/folder), or somewhere else.
- Searching for the files by filename (e.g., "log_2021-"), using your operating system search tools.
- Looking in that repository's parent (the directory/folder which contains that directory/folder), or somewhere else.
- Searching for the files by filename (e.g., "log_2021-"), using your operating system search tools.
12 changes: 6 additions & 6 deletions SIMPLEINSTALL_LINUX.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ If any of the following fails, please [write me](BUGS.md), copy/pasting all erro
To run these commands, open a terminal, and copy/paste the command, then hit enter.You may need put in your sudo/administrator password.

## Install system and python packages
Run the following commands:
Run the following commands:
1. `sudo apt-get install git python3-tk python3-pip portaudio19-dev texlive-xetex`. (This last one is a large download)
2. `python3 -m pip install pyaudio tkinter lxml Pillow`
3. `cd;git clone https://github.com/kent-rasmussen/azt.git;cd -`
Expand All @@ -20,10 +20,10 @@ Run this command: `cd;git clone https://github.com/kent-rasmussen/azt.git`.
## Set up A→Z+T for normal use
1. Download [this file](installfiles/azt.desktop). If asked, save it to your "Downloads" folder.
2. Run the following commands:
- 1. `cp $HOME/Downloads/azt.desktop $HOME/.local/share/applications/`
- 2. `sudo desktop-file-validate $HOME/.local/share/applications/azt.desktop`
- 3. `sudo update-desktop-database`
- 4. `ln $HOME/.local/share/applications/azt.desktop $HOME/Desktop/`
- `cp $HOME/Downloads/azt.desktop $HOME/.local/share/applications/`
- `sudo desktop-file-validate $HOME/.local/share/applications/azt.desktop`
- `sudo update-desktop-database`
- `ln $HOME/.local/share/applications/azt.desktop $HOME/Desktop/`
3. Click on the link on your desktop to run A→Z+T
4. **Celebrate your accomplishment; you're done installing A→Z+T!**
5. Read [USAGE](USAGE.md) for how to use A→Z+T
Expand All @@ -34,4 +34,4 @@ Run this command: `cd;git clone https://github.com/kent-rasmussen/azt.git`.
Ask someone to help you install the XMLmind XML Editor (XXE) (see [INSTALL](INSTALL.md)).

### Update A→Z+T (to be sure you're using the most recent version)
Run the command `cd $HOME/azt;git pull;cd -`.
Run the command `cd $HOME/azt;git pull;cd -`.
Binary file modified docs/BUGS.pdf
Binary file not shown.
Binary file modified docs/CHANGELOG.pdf
Binary file not shown.
Binary file added docs/FINDERRORLOGS.pdf
Binary file not shown.
Binary file modified docs/INSTALL.pdf
Binary file not shown.
Binary file added docs/INSTALL_PROBLEMS.pdf
Binary file not shown.
Binary file modified docs/README.pdf
Binary file not shown.
Binary file modified docs/ROADMAP.pdf
Binary file not shown.
Binary file added docs/SIMPLEINSTALL.pdf
Binary file not shown.
Binary file added docs/SIMPLEINSTALL_LINUX.pdf
Binary file not shown.
Binary file modified docs/USAGE.pdf
Binary file not shown.

0 comments on commit 120bad5

Please sign in to comment.