Skip to content

Commit 8540096

Browse files
author
Matthew Tole
committed
Rename package and update everything to match
1 parent 4f8641e commit 8540096

File tree

6 files changed

+26
-44
lines changed

6 files changed

+26
-44
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2014 Matthew Tole
3+
Copyright (c) 2014 - 2016 Matthew Tole
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1-
# Pebble Assist
1+
# Utils
22

3-
Pebble Assist is a small collection of [C macros][1] that make developing Pebble apps a little simpler.
3+
This is a small collection of [C macros][1] that make developing Pebble apps a little simpler.
44

55
## Usage
66

7-
Download the contents of this repository, or clone it as a submodule or subtree. I recommend having a libs subfolder in your Pebble app's src folder.
7+
You can use the new Pebble Tool to install the library from NPM.
88

9-
Include pebble-assist.h in your source code.
9+
```
10+
npm install --save @smallstoneapps/utils
11+
```
12+
13+
Include the header file in your source code.
1014

1115
```c
12-
#include "libs/pebble-assist/pebble-assist.h"
16+
#include "@smallstoneapps/utils/macros.h"
1317
```
1418

1519
## Documentation
@@ -25,10 +29,11 @@ DEBUG("Here is a logging message of value %d", 5);
2529
2630
### Layer Helpers
2731
28-
There are a number of macros for creating layers, and the various subtypes of layers. Below are some examples, check out the source code for the full list.
32+
There are a number of macros for creating layers, and the various subtypes of layers.
33+
Below are some examples, check out the source code for the full list.
2934
3035
```c
31-
// Creates a new layer that is the size of the window, and adds it to the window.
36+
// Creates a new layer that is the size of the window, and adds it to the window.
3237
// Similarly named functions exist for all layer types.
3338
Layer* layer = layer_create_fullscreen(window);
3439
layer_add_to_window(layer, window);
@@ -40,7 +45,7 @@ menu_layer_add_to_window(menu, window);
4045
```
4146
4247
```c
43-
// Prevent crashes caused by attempting to destroy an already destroyed layer,
48+
// Prevent crashes caused by attempting to destroy an already destroyed layer,
4449
// the `*_destroy_safe()` functions wrap destroy in a NULL check.
4550
layer_destroy_safe(layer);
4651
```
@@ -62,7 +67,7 @@ Check that a persistent key exists before reading it, and returning a default va
6267
int number = persist_read_int_safe(KEY_NUMBER, -1);
6368
```
6469

65-
### Miscelleanous
70+
### Miscellaneous
6671

6772
```c
6873
// Checks that data is not NULL before attempting to free.
Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,10 @@
11
/***
2-
* Pebble Assist
3-
* Copyright (C) 2014 Matthew Tole
2+
* Utils
3+
* Copyright (C) 2014 - 2016 Matthew Tole
44
*
5-
* Version 0.2.3
5+
* Version 1.1.0
66
***/
77

8-
/**
9-
The MIT License (MIT)
10-
11-
Copyright (c) 2013 Matthew Tole
12-
13-
Permission is hereby granted, free of charge, to any person obtaining a copy
14-
of this software and associated documentation files (the "Software"), to deal
15-
in the Software without restriction, including without limitation the rights
16-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17-
copies of the Software, and to permit persons to whom the Software is
18-
furnished to do so, subject to the following conditions:
19-
20-
The above copyright notice and this permission notice shall be included in
21-
all copies or substantial portions of the Software.
22-
23-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
29-
THE SOFTWARE.
30-
**/
31-
328
#pragma once
339

3410
// Pointer Logging

package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
{
2-
"name": "pebble-assist",
3-
"version": "1.0.3",
4-
"description": "Pebble Assist is a small collection of [C macros][1] that make developing Pebble apps a little simpler.",
5-
"main": "include/pebble-assist.h",
2+
"name": "@smallstoneapps/utils",
3+
"version": "1.1.0",
4+
"description": "A small collection of [C macros][1] that make developing Pebble apps a little simpler.",
5+
"main": "include/macros.h",
66
"scripts": {
77
"test": "echo \"Error: no test specified\" && exit 1"
88
},
99
"repository": {
1010
"type": "git",
11-
"url": "git+https://github.com/smallstoneapps/pebble-assist.git"
11+
"url": "git+https://github.com/smallstoneapps/utils.git"
1212
},
1313
"author": "Matthew Tole <[email protected]>",
1414
"license": "MIT",
1515
"bugs": {
16-
"url": "https://github.com/smallstoneapps/pebble-assist/issues"
16+
"url": "https://github.com/smallstoneapps/utils/issues"
1717
},
18-
"homepage": "https://github.com/smallstoneapps/pebble-assist#readme",
18+
"homepage": "https://github.com/smallstoneapps/utils#readme",
1919
"pebble": {
2020
"uuid": "3ee0504a-6e63-4b41-ab91-c66c73be3407",
2121
"sdkVersion": "3",

src/c/macros.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// This file only exists because the library won't build without a source file.

src/c/pebble-assist.c

Whitespace-only changes.

0 commit comments

Comments
 (0)