Skip to content

Commit

Permalink
updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
IanMulvany committed Aug 6, 2013
1 parent f134ea0 commit 55eb3ec
Showing 1 changed file with 91 additions and 1 deletion.
92 changes: 91 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,94 @@

For a demo and more information see: http://lens.elifesciences.org

To suggest a feature, report a bug, or general discussion: http://github.com/elifesciences/lens/issues/


### Participating and Contributing

Participation is highly encouraged.

To suggest a feature, report a bug: http://github.com/elifesciences/lens/issues/

For general discussion join the mailing list/web forum: https://groups.google.com/forum/#!forum/elife-lens

To get an overview of what we are currently working on now, and to see what we would like to work on in the future have a look at our roadmap: https://github.com/elifesciences/lens/wiki/Product-Roadmap

To contribute to the project, please fork the project, and submit your pull requests. We will code review submissions, and a track record of good submissions will build confidence, and gain you access to direct access to the repo.

The core team meets on a google+ hangout regularly. If you would like to join the core team, please consider supporting the project through either
code contributions, or a finanial commitment to support development.

### The Lens Article Format

The [Lens Article Format](http://github.com/elifesciences/lens-article) is a JSON based document model designed for representing scientific content. It features basic content types such as paragraphs, headings, and various figure types such as images, tables and videos complete with captions and cross-references.

We're working on releasing the first official verison of the spec.

### Install

Installing and running Lens locally is quite simple, since all you need is Node.js (our dev environment) and a web-browser.


1. Clone the repository

```bash
$ git clone https://github.com/elifesciences/lens.git
```

2. Run the lens script, which pulls in all the dependencies

```bash
$ cd lens
$ substance --update
```

3. Finally start the server and point your browser to `http://localhost:4000`

```bash
$ substance --start
```


### Development workflows


#### Work with feature branches

A good start is working with fresh feature branches.

1. Create a feature branch across all sub-modules.

```bash
$ substance --git -- checkout -b <feature_branch_name>
```

2. Edit `project.json` manually (replace branch: master with your feature-branch-name)

3. Checkout configured branches of sub-modules

```bash
$ substance --checkout
```

#### To pull in upstream changes from master.

```
substance --git -- pull origin master:<feature_branch_name>
```


### Deployment

This is not yet implemented, but in a couple of weeks you'll be able to bundle Lens as a static web page as simple as this.

```bash
$ substance --bundle
```

It creates a `dist` folder with everything you need.


### Roadmap

The Roadmap is covered on the [project wiki](https://github.com/elifesciences/lens/wiki/Product-Roadmap)

0 comments on commit 55eb3ec

Please sign in to comment.