← Back to branch summary

~stephen-stewart/ulysses/move-box-sizing-to-base

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Tarmac
  • Author(s): Stephen Stewart
  • Date: 2014-09-25 09:26:43 UTC
  • mfrom: (43.1.14 gulpify-and-update)
  • Revision ID: tarmac-20140925092643-jzluuaboybxm4q73
[r=james-w] update to version 1.0.0

* update grids to pure 0.5
* default to border-box
* default to minified css
* switch to gulp
* remove bower dep
* svg symbols

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.md
1
 
Ulysses
2
 
=======
 
1
# Ulysses
 
2
 
 
3
All Ulysses CSS is prebuilt, minified and available in /public, as individual
 
4
modules or a single concatenated file (ulysses.css).
 
5
 
 
6
You can view a test page with:
 
7
```
 
8
cd test && python -m SimpleHTTPServer
 
9
```
 
10
 
 
11
If you want to edit you'll need to install nodejs, this is left as an
 
12
exercise for the reader. Once nodejs is installed:
 
13
 
 
14
## Fonts and Testing
 
15
 
 
16
The regression tests should be run on Ubuntu Precise with the Ubuntu font
 
17
family installed. Otherwise all tests will fail on OS rendering diff or 
 
18
font family diff. To install Ubuntu font via cli:
3
19
 
4
20
``
5
21
sudo apt-get install ttf-ubuntu-font-family
 
22
``
 
23
 
 
24
## Hacking
 
25
 
 
26
Install build deps:
 
27
 
 
28
```
6
29
npm install
7
 
grunt run
8
 
grunt test
9
 
``
 
30
```
 
31
 
 
32
Build on file change:
 
33
```
 
34
gulp watch
 
35
```
 
36
 
 
37
See gulpfile.js for more.
 
38
 
 
39
### Tests
 
40
 
 
41
Visual regression testing is handled by PhantomCSS:
 
42
 
 
43
```
 
44
gulp test
 
45
```
 
46
 
 
47
### Updates to lib CSS
 
48
 
 
49
To update lib CSS (normalize, Pure, etc) to latest version in npm, check
 
50
with npm:
 
51
 
 
52
```
 
53
npm outdated normalize.css purecss
 
54
```
 
55
 
 
56
Update package.json if required and run gulp task to copy updated libs to /src:
 
57
 
 
58
```
 
59
gulp copy
 
60
```
 
61
 
 
62
Create new svg symbols:
 
63
 
 
64
```
 
65
gulp symbols
 
66
```