Skip to content

Commit dfce756

Browse files
author
Audun Kjelstrup
committed
Documentation edits reflecting issue #29
1 parent 9f22255 commit dfce756

File tree

5 files changed

+31
-38
lines changed

5 files changed

+31
-38
lines changed

app/components/hero/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export default class Hero extends React.Component {
77
<div className={styles.hero}>
88
<div className="wrapper">
99
<h1>Roc</h1>
10-
<h2>Modern web development system</h2>
10+
<h2>Modern web development made easy</h2>
1111
<code className={styles.install}>npm install roc -g</code>
1212
</div>
1313
</div>

docs/GETSTARTED.md

+20-27
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting started with Roc
22

3-
This guide will walk you through how to set up your first project using React. This is just one example on how an application can be created. More guides and and documentation is on the way.
3+
This guide will walk you through how to set up your first project using Roc. This is just one example on how an application can be created. More guides and and documentation is on the way.
44

55
## Install
66
Make sure you have [Node.js](https://nodejs.org) 4.x or higher and [npm](https://www.npmjs.com/) 3.x or higher on your system.
@@ -12,36 +12,12 @@ npm install -g roc
1212
```
1313
`roc` will now be available globally on your system.
1414

15-
## Create new Redux and React project
16-
Create directory for your app:
17-
```
18-
mkdir react-app && cd react-app
19-
```
15+
## Create new Roc project
2016
Bootstrap app starting point:
2117
```
22-
roc init web-react
23-
```
24-
### Tip
25-
`web-react` is an alias to `vgno/roc-template-web-react`, a [repository location](https://github.com/vgno/roc-template-web-react) on Github. This template then uses the [roc-web-react](https://github.com/vgno/roc-web-react) extension. You can use your own repository by running `roc init GITHUB_USER/REPO`.
26-
27-
You _can_ create your own extensions but that is outside the scope of this guide.
28-
29-
## Development mode
30-
```
31-
roc dev
32-
```
33-
While this command is running the following is at your disposal:
34-
- See your app running at http://localhost:3002 with Browsersync support.
35-
- Manage your BrowserSync instance at http://localhost:3003. Connect as many different devices as you like.
36-
- Live reloading is active, and code can be live-edited and will be live-pushed to your browser.
37-
38-
## View (dynamic) configuration options
39-
```
40-
roc dev --help
18+
roc init my-first-roc-project
4119
```
4220

43-
This prints all options that you can use to configure your current application. They are defined by the extensions that we use; currently `roc-web-react` in this guide. The runtime `cli` parameters are compatible with permanent values in `roc.config.js`.
44-
4521
## Default project structure
4622
The basic template defines this for you, but you may modify it to use an entirely different structure easily through `roc.config.js`.
4723

@@ -96,6 +72,23 @@ module.exports = {
9672
};
9773
```
9874

75+
76+
## Development mode
77+
```
78+
roc dev
79+
```
80+
While this command is running the following is at your disposal:
81+
- See your app running at http://localhost:3002 with Browsersync support.
82+
- Manage your BrowserSync instance at http://localhost:3003. Connect as many different devices as you like.
83+
- Live reloading is active, and code can be live-edited and will be live-pushed to your browser.
84+
85+
## View (dynamic) configuration options
86+
```
87+
roc dev --help
88+
```
89+
90+
This prints all options that you can use to configure your current application. They are defined by the extensions that we use; currently `roc-web-react` in this guide. The runtime `cli` parameters are compatible with permanent values in `roc.config.js`.
91+
9992
## Change application configuration
10093
Permanent configurations belonging to your application should be defined in `roc.config.js`.
10194

docs/HERO.md

+5
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,8 @@ OR
1010

1111
ROC [LOGO]
1212
Modern development productivity
13+
14+
OR
15+
16+
ROC [LOGO]
17+
Modern web development made easy

docs/QUICKSTART-1.md

+3-8
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,10 @@ Make sure you have node 4.x+ and npm 3.x+ on your system.
44
npm install -g roc
55
```
66

7-
#### Create redux and react project
8-
```
9-
mkdir react-app
10-
```
11-
```
12-
cd react-app
13-
```
7+
#### Create Roc project
8+
149
```
15-
roc init web-react
10+
roc init my-first-roc-project
1611
```
1712

1813
#### Start development mode

docs/QUICKSTART-2.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ roc start
1717

1818
#### Questions
1919

20-
##### Is this production ready?
20+
##### *Is this production ready?*
2121

2222
It is in active development, but please start experimenting today!
2323

24-
##### Will this be abandoned tomorrow?
24+
##### *Will this be abandoned tomorrow?*
2525

2626
No! VG has have a long plan for Roc going forward.

0 commit comments

Comments
 (0)