Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docker documentation to clarify usage. #231

Merged
merged 4 commits into from
Apr 26, 2022
Merged

Update Docker documentation to clarify usage. #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4d59442
WIP update to Docker documentation to clarify usage.
tmiw Apr 25, 2022
e1f90c9
Rename FREEDV_GUI_FOLDER to FREEDV_GUI.
tmiw Apr 25, 2022
6a3e305
Add PR#231 to changelog.
tmiw Apr 25, 2022
4abdedb
latest user manual PDF
tmiw Apr 25, 2022
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
1 change: 1 addition & 0 deletions USER_MANUAL.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,7 @@ <h2 id="tbd-april-2022"><span class="header-section-number">16.1</span> TBD Apri
<li>Documentation:
<ul>
<li>Add troubleshooting instructions for serial port PTT on Windows. (PR #226)</li>
<li>Clarify location from where to run Docker build script. (PR #231)</li>
</ul></li>
</ol>
<h2 id="v1.7.0-february-2022"><span class="header-section-number">16.2</span> V1.7.0 February 2022</h2>
Expand Down
1 change: 1 addition & 0 deletions USER_MANUAL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -796,6 +796,7 @@ LDPC | Low Density Parity Check Codes - a family of powerful FEC codes
* Build Windows build on every Git push. (PR #220)
3. Documentation:
* Add troubleshooting instructions for serial port PTT on Windows. (PR #226)
* Clarify location from where to run Docker build script. (PR #231)

## V1.7.0 February 2022

Expand Down
Binary file modified USER_MANUAL.pdf
View file
Open in desktop
Binary file not shown.
12 changes: 9 additions & 3 deletions docker/README_docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,22 @@ docker container run hello-world

## Building the docker images
Building is only required once, or if you modify the docker scripts

```
cd $FREEDV_GUI/docker
docker-compose -f docker-compose-win.yml build
```

## Running the docker image to build Windows installers

```
./freedv_build_windows.sh 64
./freedv_build_windows.sh 32
cd $FREEDV_GUI/docker
./freedv_build_windows.sh 64
./freedv_build_windows.sh 32
```

See `build_log.txt` for a record of the build. More options are available with:

```
./freedv_build_windows.sh -h
./freedv_build_windows.sh -h
```