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

Commit

Permalink
Clean up project & documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
damien-rivet committed Mar 11, 2018
1 parent 0309c34 commit 2f534e3
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 115 deletions.
6 changes: 3 additions & 3 deletions .jazzy.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
module: CasperSplash
module: SplashBuddy
author: François Levaux-Tiffreau
author_url: https://maclovin.org
github_url: https://github.com/ftiff/CasperSplash
github_url: https://github.com/ShufflePuck/SplashBuddy
copyright: 'GPLv3'
xcodebuild_arguments: [-target, CasperSplash]
xcodebuild_arguments: [-target, SplashBuddy]
clean: true
min_acl: private
skip_undocumented: true
Expand Down
67 changes: 0 additions & 67 deletions Assets/Mac-Developer-20180129.p12.enc

This file was deleted.

21 changes: 10 additions & 11 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Change Log

All notable changes to this project will be documented in this file.

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


## [1.2]

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

### Changed

* Brand new Layout!
* Added Temporary exception to sandbox to allow sending Apple Events to Login Window (to restart etc.)
* Continue button can now be hidden
* Moved Userinput on a separate branch. Feature is not ready for 1.1

### Fixed

* `.SplashBuddyDone` will be set when all critical items are done (`canContinue` = `false`) (@LovelessInSeattle)
* A failed item will no longer activate continue button (@LovelessInSeattle)

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

# Contributors
## Contributors

## Code

- François 'ftiff' Levaux-Tiffreau (@ftiff)
- @cybertunnel
- Joel Rennich (@mactroll)

* François 'ftiff' Levaux-Tiffreau (@ftiff)
* @cybertunnel
* Joel Rennich (@mactroll)

## Localization

- French (fr): François Levaux-Tiffreau (@ftiff)
- Dutch (nl): @riddl0rd, @thomasb
- German (de): Mic Milic Frederickx (@kermic)


* French (fr): François Levaux-Tiffreau (@ftiff)
* Dutch (nl): @riddl0rd, @thomasb
* German (de): Mic Milic Frederickx (@kermic)
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
👏🏼💕😎 Thanks for taking the time to contribute!! 😎💕👏🏼

# Contributing Guide

👏🏼💕😎 Thanks for taking the time to contribute!! 😎💕👏🏼

## What should I know before starting?

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

### Contributing to localizations

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

### Contributing to documentation

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

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.
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.

### Contributing to code

Please create a pick a topic in the issues section:

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

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

Expand Down
32 changes: 14 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,47 @@
[![Build Status](https://travis-ci.org/ftiff/SplashBuddy.svg?branch=master)](https://travis-ci.org/ftiff/SplashBuddy)
![](https://img.shields.io/badge/Swift-4.0-brightgreen.svg)
![](https://img.shields.io/badge/macOS-10.12.6-brightgreen.svg)
![](https://img.shields.io/badge/macOS-10.13-brightgreen.svg)

# SplashBuddy

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

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

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

It allows you to:

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

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.
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.

## In action

![](Assets/secrid_splashbuddy.jpeg)
![SplashBuddy](Assets/secrid_splashbuddy.jpeg)

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).

## Quick Start

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

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

## Release history

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

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


## Getting help
## Getting help

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

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


## Contributing

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.
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.

You can also [contribute](https://github.com/ftiff/SplashBuddy/blob/master/CONTRIBUTING.md) and be part of this list.
You can also [contribute](https://github.com/Shufflepuck/SplashBuddy/blob/master/CONTRIBUTING.md) and be part of this list.
1 change: 0 additions & 1 deletion SplashBuddy/Resources/fi.lproj/Localizable.strings
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
Strings.strings
SplashBuddy

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

Expand Down
14 changes: 6 additions & 8 deletions THANKS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Community
# Thanks

## Community

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

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



# Code
## Code

- François 'ftiff' Levaux-Tiffreau (@ftiff)
- @cybertunnel
- Joel Rennich (@mactroll)


# Localization
## Localization

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


# Similar projects
## Similar projects

- IBM
- ProgressScreen

0 comments on commit 2f534e3

Please sign in to comment.