Skip to content
This repository was archived by the owner on Feb 8, 2023. It is now read-only.

Commit 2f534e3

Browse files
committed
Clean up project & documentation
1 parent 0309c34 commit 2f534e3

File tree

7 files changed

+40
-115
lines changed

7 files changed

+40
-115
lines changed

.jazzy.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
module: CasperSplash
1+
module: SplashBuddy
22
author: François Levaux-Tiffreau
33
author_url: https://maclovin.org
4-
github_url: https://github.com/ftiff/CasperSplash
4+
github_url: https://github.com/ShufflePuck/SplashBuddy
55
copyright: 'GPLv3'
6-
xcodebuild_arguments: [-target, CasperSplash]
6+
xcodebuild_arguments: [-target, SplashBuddy]
77
clean: true
88
min_acl: private
99
skip_undocumented: true

Assets/Mac-Developer-20180129.p12.enc

Lines changed: 0 additions & 67 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Change Log
2+
23
All notable changes to this project will be documented in this file.
34

45
The format is based on [Keep a Changelog](http://keepachangelog.com/)
56
and this project adheres to [Semantic Versioning](http://semver.org/).
67

7-
88
## [1.2]
99

1010
### Added
@@ -30,12 +30,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
3030
* Italian localization
3131

3232
### Changed
33+
3334
* Brand new Layout!
3435
* Added Temporary exception to sandbox to allow sending Apple Events to Login Window (to restart etc.)
3536
* Continue button can now be hidden
3637
* Moved Userinput on a separate branch. Feature is not ready for 1.1
3738

3839
### Fixed
40+
3941
* `.SplashBuddyDone` will be set when all critical items are done (`canContinue` = `false`) (@LovelessInSeattle)
4042
* A failed item will no longer activate continue button (@LovelessInSeattle)
4143

@@ -86,19 +88,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
8688
* Disable relaunch on login. This should be controlled by a LaunchAgent. (thanks @grahamrpugh)
8789
* Background window now stays in front of Dock (thanks @jwojda)
8890

89-
# Contributors
91+
## Contributors
9092

9193
## Code
9294

93-
- François 'ftiff' Levaux-Tiffreau (@ftiff)
94-
- @cybertunnel
95-
- Joel Rennich (@mactroll)
96-
95+
* François 'ftiff' Levaux-Tiffreau (@ftiff)
96+
* @cybertunnel
97+
* Joel Rennich (@mactroll)
9798

9899
## Localization
99100

100-
- French (fr): François Levaux-Tiffreau (@ftiff)
101-
- Dutch (nl): @riddl0rd, @thomasb
102-
- German (de): Mic Milic Frederickx (@kermic)
103-
104-
101+
* French (fr): François Levaux-Tiffreau (@ftiff)
102+
* Dutch (nl): @riddl0rd, @thomasb
103+
* German (de): Mic Milic Frederickx (@kermic)

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
👏🏼💕😎 Thanks for taking the time to contribute!! 😎💕👏🏼
2-
31
# Contributing Guide
42

3+
👏🏼💕😎 Thanks for taking the time to contribute!! 😎💕👏🏼
4+
55
## What should I know before starting?
66

77
SplashBuddy goal is to provide an *elegant* and *secure* onboarding process for Mac users using [DEP](https://www.apple.com/business/dep/).
@@ -25,20 +25,20 @@ By *secure* we mean:
2525

2626
### Contributing to localizations
2727

28-
Please [create an issue](https://github.com/ftiff/SplashBuddy/issues/new) if a localization is incorrect, incomplete or missing.
28+
Please [create an issue](https://github.com/Shufflepuck/SplashBuddy/issues/new) if a localization is incorrect, incomplete or missing.
2929

3030
### Contributing to documentation
3131

32-
The [wiki](https://github.com/ftiff/SplashBuddy/wiki) is open to edit for everyone. Don't hesitate to modify it!
32+
The [wiki](https://github.com/Shufflepuck/SplashBuddy/wiki) is open to edit for everyone. Don't hesitate to modify it!
3333

34-
Please ask for help in the Slack channel (see below) or [create an issue](https://github.com/ftiff/SplashBuddy/issues/new) if you're uncertain.
34+
Please ask for help in the Slack channel (see below) or [create an issue](https://github.com/Shufflepuck/SplashBuddy/issues/new) if you're uncertain.
3535

3636
### Contributing to code
3737

3838
Please create a pick a topic in the issues section:
3939

40-
* [Beginner issues](https://github.com/ftiff/SplashBuddy/labels/beginner) - issues which should only require a few lines of code, and a test or two.
41-
* [Help wanted issues](https://github.com/ftiff/SplashBuddy/labels/help%20wanted) - issues which should be a bit more involved than `beginner` issues.
40+
* [Beginner issues](https://github.com/Shufflepuck/SplashBuddy/labels/beginner) - issues which should only require a few lines of code, and a test or two.
41+
* [Help wanted issues](https://github.com/Shufflepuck/SplashBuddy/labels/help%20wanted) - issues which should be a bit more involved than `beginner` issues.
4242

4343
Please start from `master` branch and create a PR when you're ready to submit the code.
4444

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,47 @@
1-
[![Build Status](https://travis-ci.org/ftiff/SplashBuddy.svg?branch=master)](https://travis-ci.org/ftiff/SplashBuddy)
2-
![](https://img.shields.io/badge/Swift-4.0-brightgreen.svg)
3-
![](https://img.shields.io/badge/macOS-10.12.6-brightgreen.svg)
4-
![](https://img.shields.io/badge/macOS-10.13-brightgreen.svg)
5-
1+
# SplashBuddy
62

7-
![](https://img.shields.io/badge/Version-1.2.0-lightgrey.svg)
8-
![](https://img.shields.io/badge/License-Apache%202.0-lightgrey.svg)
3+
[![Build Status](https://travis-ci.org/Shufflepuck/SplashBuddy.svg?branch=master)](https://travis-ci.org/Shufflepuck/SplashBuddy)
4+
![Swift](https://img.shields.io/badge/Swift-4.0-brightgreen.svg)
5+
![macOS](https://img.shields.io/badge/macOS-10.12.6-brightgreen.svg)
6+
![macOS](https://img.shields.io/badge/macOS-10.13-brightgreen.svg)
97

10-
# SplashBuddy
8+
![Version](https://img.shields.io/badge/Version-1.2.0-lightgrey.svg)
9+
![License](https://img.shields.io/badge/License-Apache%202.0-lightgrey.svg)
1110

12-
SplashBuddy goal is to provide an *elegant* and *secure* onboarding process for Mac users using [DEP](https://www.apple.com/business/dep/).
11+
SplashBuddy goal is to provide an *elegant* and *secure* onboarding process for Mac users using [DEP](https://www.apple.com/business/dep/).
1312

1413
It allows you to:
1514

1615
- Prevent your users from using their Mac before the minimum software is installed
1716
- Provide status on the software that is currently being installed
1817
- Display important information
1918

20-
It currently supports Jamf Pro. You're welcome to [contribute](https://github.com/ftiff/SplashBuddy/blob/master/CONTRIBUTING.md) to the project. Every little helps.
19+
It currently supports Jamf Pro. You're welcome to [contribute](https://github.com/Shufflepuck/SplashBuddy/blob/master/CONTRIBUTING.md) to the project. Every little helps.
2120

2221
## In action
2322

24-
![](Assets/secrid_splashbuddy.jpeg)
23+
![SplashBuddy](Assets/secrid_splashbuddy.jpeg)
2524

2625
Here's a video of the SplashBuddy (v1.0) running at Culture Amp that was presented during [Macbrained](http://smithjw.me/2017/03/24/Onboarding-talk-at-Macbrained/): [Link](https://cultureamp.wistia.com/medias/8gpvhpwgn4).
2726

2827
## Quick Start
2928

30-
The best place to start is the [Kickstart Guide](https://github.com/ftiff/SplashBuddy/wiki/30---kickstart-guide).
31-
29+
The best place to start is the [Kickstart Guide](https://github.com/Shufflepuck/SplashBuddy/wiki/30---kickstart-guide).
3230

3331
## Release history
3432

3533
The release history is available [here](CHANGELOG.md).
3634

3735
Splashbuddy was made possible thanks to the work of [the following individuals](THANKS.md).
3836

39-
40-
## Getting help
37+
## Getting help
4138

4239
The best place to discuss SplashBuddy is to join the `#splashbuddy` channel on the [MacAdmins Slack](https://macadmins.herokuapp.com).
4340

4441
[Subscribe to the newsletter](http://eepurl.com/cZZ50T) to get news, tips and tricks.
4542

46-
4743
## Contributing
4844

49-
I (ftiff) have been working countless hours at night for two years to bring SplashBuddy to life. [Many others](https://github.com/ftiff/SplashBuddy/blob/master/THANKS.md) invested time in it too.
45+
I (ftiff) have been working countless hours at night for two years to bring SplashBuddy to life. [Many others](https://github.com/Shufflepuck/SplashBuddy/blob/master/THANKS.md) invested time in it too.
5046

51-
You can also [contribute](https://github.com/ftiff/SplashBuddy/blob/master/CONTRIBUTING.md) and be part of this list.
47+
You can also [contribute](https://github.com/Shufflepuck/SplashBuddy/blob/master/CONTRIBUTING.md) and be part of this list.

SplashBuddy/Resources/fi.lproj/Localizable.strings

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
Strings.strings
33
SplashBuddy
44

5-
Created by Francois Levaux on 02.03.17.
65
Copyright © 2017 François Levaux-Tiffreau. All rights reserved.
76
*/
87

THANKS.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Community
1+
# Thanks
2+
3+
## Community
24

35
A huge thanks to the community on #SplashBuddy on the MacAdmins Slack, and especially:
46

@@ -15,23 +17,19 @@ A huge thanks to the community on #SplashBuddy on the MacAdmins Slack, and espec
1517
- @rudy 🏈
1618
- @smithjw 🕺
1719

18-
19-
20-
# Code
20+
## Code
2121

2222
- François 'ftiff' Levaux-Tiffreau (@ftiff)
2323
- @cybertunnel
2424
- Joel Rennich (@mactroll)
2525

26-
27-
# Localization
26+
## Localization
2827

2928
- French (fr): François Levaux-Tiffreau (@ftiff)
3029
- Dutch (nl): @riddl0rd, @thomasb
3130
- German (de): Mic Milic Frederickx (@kermic), Christoph Fellner (@christophf)
3231

33-
34-
# Similar projects
32+
## Similar projects
3533

3634
- IBM
3735
- ProgressScreen

0 commit comments

Comments
 (0)