Skip to content

Commit 0feca94

Browse files
Kyunghyun YeoKyunghyun Yeo
Kyunghyun Yeo
authored and
Kyunghyun Yeo
committed
init
0 parents  commit 0feca94

File tree

4 files changed

+109
-0
lines changed

4 files changed

+109
-0
lines changed

.gitignore

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# generic (system) files/extensions we don't want
2+
*.seed
3+
*.log
4+
*.csv
5+
*.dat
6+
*.out
7+
*.pid
8+
*.gz
9+
.idea/*
10+
*.DS_Store
11+
lib-cov
12+
pids
13+
logs
14+
results
15+
16+
node_modules
17+
18+
bower_components

CHANGELOG.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Version numbers correspond to `bower.json` version
2+
3+
# 1.0.0
4+
5+
## Features
6+
7+
## Bug Fixes
8+
9+
## Breaking Changes

README.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# AngularJS seven segment display directive
2+
3+
[TODO - brief summary]
4+
5+
## Demo
6+
http://kenny.github.io/angular-7seg/
7+
8+
## Dependencies
9+
- required:
10+
[TODO]
11+
- optional
12+
[TODO]
13+
14+
See `bower.json` and `index.html` in the `gh-pages` branch for a full list / more details
15+
16+
## Install
17+
1. download the files
18+
1. Bower
19+
1. add `"angular-7seg": "latest"` to your `bower.json` file then run `bower install` OR run `bower install angular-7seg`
20+
2. include the files in your app
21+
1. `7seg.min.js`
22+
2. `7seg.less` OR `7seg.min.css` OR `7seg.css`
23+
3. include the module in angular (i.e. in `app.js`) - `kenny.angular-7seg`
24+
25+
See the `gh-pages` branch, files `bower.json` and `index.html` for a full example.
26+
27+
28+
## Documentation
29+
See the `7seg.js` file top comments for usage examples and documentation
30+
https://github.com/kenny/angular-7seg/blob/master/7seg.js
31+
32+
33+
## Development
34+
35+
1. `git checkout gh-pages`
36+
1. run `npm install && bower install`
37+
2. write your code then run `grunt`
38+
3. git commit your changes
39+
2. copy over core files (.js and .css/.less for directives) to master branch
40+
1. `git checkout master`
41+
2. `git checkout gh-pages 7seg.js 7seg.min.js 7seg.less 7seg.css 7seg.min.css`
42+
3. update README, CHANGELOG, bower.json, and do any other final polishing to prepare for publishing
43+
1. git commit changes
44+
2. git tag with the version number, i.e. `git tag v1.0.0`
45+
4. create github repo and push
46+
1. [if remote does not already exist or is incorrect] `git remote add origin [github url]`
47+
2. `git push origin master --tags` (want to push master branch first so it is the default on github)
48+
3. `git checkout gh-pages`
49+
4. `git push origin gh-pages`
50+
5. (optional) register bower component
51+
1. `bower register angular-7seg [git repo url]`

bower.json

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "angular-7seg",
3+
"version": "1.0.0",
4+
"authors": [
5+
"Kenny Yeo <[email protected]>"
6+
],
7+
"description": "AngularJS seven segment display directive",
8+
"keywords": [
9+
"angular",
10+
"AngularJS",
11+
"seven",
12+
"segment",
13+
"directive"
14+
],
15+
"license": "MIT",
16+
"ignore": [
17+
"**/.*",
18+
"node_modules",
19+
"bower_components",
20+
"test",
21+
"tests"
22+
],
23+
"dependencies": {
24+
"angular":"~1.2.0",
25+
"angular-animate":"~1.2.0",
26+
"angular-sanitize":"~1.2.0",
27+
"angular-touch":"~1.2.0"
28+
},
29+
"devDependencies": {
30+
}
31+
}

0 commit comments

Comments
 (0)