Skip to content

Commit

Permalink
Doc updates for v3
Browse files Browse the repository at this point in the history
  • Loading branch information
brucemack committed Jan 18, 2021
1 parent 6a9b50a commit 203e581
Showing 1 changed file with 32 additions and 7 deletions.
39 changes: 32 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,20 @@ On Windows:
* pip install Flask
* pip install PyInstaller

NOTE: This is needed to work around a bug in Windows 10 2004. See https://developercommunity.visualstudio.com/content/problem/1207405/fmod-after-an-update-to-windows-2004-is-causing-a.html
Resolvoing Numpy Problen on Windows 10 2004
--------------------------------------------
This is needed to work around a bug in Windows 10 2004. See https://developercommunity.visualstudio.com/content/problem/1207405/fmod-after-an-update-to-windows-2004-is-causing-a.html

Microsoft is supposed to have this problem fixed in the next update
of Windows 10.

pip install numpy==1.19.3

Running
=======
Running (Development Mode)
==========================
Windows, command-line, development:

* python main.py .
* python main.py

Building Requirements
=====================
Expand All @@ -41,12 +46,27 @@ Building Requirements

PyInstaller Packaging
=====================

* pip install PyInstaller
* pyinstaller --onefile main.py --name nanovna-controller

The .exe will end up in /dist
Zip the .exe, config.ini, and the static folder together.

Resolving Issues with PyInstaller Virus Detection
-------------------------------------------------
Many anti-malware tools have a problem with the pre-built bootloader
shipped in the standard PyInstaller distribution. The work-around
is to pull the source distribution of PyInstaller and build the
bootloader locally.

* git clone https://github.com/pyinstaller/pyinstaller.git
* cd pyinstaller
* cd bootloader
* python ./waf all
* Switch to the nanovna-controller virtual environment
* pip install c:/Users/bruce/git/pyinstaller

Links
=====
* Prototype UI: https://brucemack.github.io/nanovna
Expand All @@ -64,18 +84,23 @@ Precise Installation Instructions

Change Notes
============
Version 3:

Version 3
---------
* Major rework of calibration process.
* Cleaned up some of the noise on the console window at startup.
* Automatically stripping spaces from serial port entry.
* If a single number is entered into the serial port box, automatically at the "com" prefix.
* Fixed problem with complex impedance. Now showing real and imaginary components.
* Using locally compiled bootloader to avoid issues with Windows Threat Detection.

Version 2:
Version 2
---------
* Defaults to COM6
* Able to auto-sense the base dir
* Error checks for config.ini and static dir
* Changing numpuy version to address Windows bug

Version 1:
Version 1
---------
* Initial version

0 comments on commit 203e581

Please sign in to comment.