Skip to content
This repository has been archived by the owner on Sep 26, 2022. It is now read-only.

Commit

Permalink
Merge branch 'update-docs'
Browse files Browse the repository at this point in the history
  • Loading branch information
JMSwag committed Jan 20, 2017
2 parents 878bdcc + e647e4b commit 2b4c98d
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 8 deletions.
1 change: 1 addition & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

- Libs
- certifi 2016.9.26
- dsdev-utils 0.9.4
- urllib3 1.20

###Fixed
Expand Down
16 changes: 15 additions & 1 deletion docs/danger-zone.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,18 @@

###Spec File

Do not change the name attribute in the spec file
Do not change the name attribute in the spec file


###Version Numbers

Version numbers should be in the format specified below. Supported release versions are alpha & beta. For shorthand you can use a & b respectively.

1.0
1.0alpha
1.0alpha
1.0-alpha2
1.0-alpha-3
1.0.1beta
1.0.1-beta2
1.0.1-beta-3
10 changes: 4 additions & 6 deletions docs/usage-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,21 +64,19 @@ if lib_update is not None:
```

###Step 6 - Make Spec
####Is your app more of the demanding type? If so, your spec file must be based on a PyUpdater generated spec file. You can easily generate one using the example below. If you do not need a custom spec file skip to the next step. * Warning * Do not change the name attribute in the spec file.
####Is your app more of the demanding type? If so, your spec file must be based on a PyUpdater generated spec file. You can easily generate one using the example below. If you do not need a custom spec file skip to the next step. Please see the Danger Zone section on spec files.
```
$ pyupdater make-spec -w main.py
```

###Step 7 - Build
####Now let's build our app. You have two options when building. You can specify a spec file or a main script.
####Now let's build our app. You have two options when building. You can specify a spec file or a main script. Please see the Danger Zone section on version numbers.

#####Build from a spec file.
```
# Build from a spec file.
$ pyupdater build --app-version=1.0.0 main.spec
```
#####Build from a script.
```
# Build from a script.
$ pyupdater build --app-version=1.0.0 main.py
```

Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
appdirs == 1.4.0
bsdiff4 == 1.1.4
certifi >= 2016.9.26
dsdev-utils >= 0.9.2
dsdev-utils >= 0.9.4
ed25519 == 1.4
pyinstaller >= 3.0
six == 1.10.0
Expand Down

0 comments on commit 2b4c98d

Please sign in to comment.