Skip to content

Commit fd3f449

Browse files
committed
Updating readme
1 parent 7999d83 commit fd3f449

File tree

3 files changed

+16
-15
lines changed

3 files changed

+16
-15
lines changed

CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# Contributing to lumino
1+
# Contributing to Lumino
22

3-
lumino is a subproject of Project Jupyter and subject to the [Jupyter governance](https://github.com/jupyter/governance) and [Code of conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md).
3+
Lumino is a subproject of Project Jupyter and subject to the [Jupyter governance](https://github.com/jupyter/governance) and [Code of conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md).
44

55
## General Guidelines
66

77
For general documentation about contributing to Jupyter projects, see the [Project Jupyter Contributor Documentation](https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html).
88

99
## Setting up a development environment
1010

11-
lumino requires [nodejs](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/lang/en/) for local development. After
12-
cloning lumino, run the following to install dependencies and build the source:
11+
Lumino requires [nodejs](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/lang/en/) for local development. After
12+
cloning Lumino, run the following to install dependencies and build the source:
1313

1414
```bash
1515
yarn
@@ -29,7 +29,7 @@ yarn test # optionally test:chrome, test:firefox, or test:ie
2929

3030
## Examples
3131

32-
lumino examples are in the `examples/` folder. To build and run an example:
32+
Lumino examples are in the `examples/` folder. To build and run an example:
3333

3434
```bash
3535
yarn build:examples

README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
# lumino
1+
# Lumino
22

33
[![Build Status](https://travis-ci.org/jupyterlab/lumino.svg?branch=master)](https://travis-ci.org/jupyterlab/lumino)
44

5-
lumino is a set of JavaScript packages, written in TypeScript, that provide
6-
a rich set of widgets, layouts, events, and data structures. These enable
7-
developers to construct advanced, production-quality, desktop-like web
8-
applications that would be otherwise impossible using CSS alone.
5+
Lumino is a set of JavaScript packages, written in TypeScript, that provide
6+
a rich toolkit of widgets, layouts, events, and data structures. These enable
7+
developers to construct extensible high-performance desktop-like web
8+
applications, such as JupyterLab. Lumino was formerly known as PhosphorJS.
99

10-
lumino follows the Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/community/content-community.html).
10+
Lumino is Jupyter project and follows the Jupyter
11+
[Community Guides and Code of Conduct](https://jupyter.readthedocs.io/en/latest/community/content-community.html).
1112

12-
# Development
13+
## Development
1314

14-
See [CONTRIBUTING.md](./CONTRIBUTING.md) to know how to contribute and set up a development environment.
15+
See [CONTRIBUTING.md](./CONTRIBUTING.md) to know how to contribute and set up
16+
a development environment.

RELEASE.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
Release instructions for lumino
1+
# Release instructions for Lumino
22

33
Check for releases since the last published version to determine appropriate
44
patch/minor/major version changes.
55
If a dependent package moves by minor/major, then that package needs to jump
66
minor/major as well.
77

8-
98
```bash
109
git clean -dfx
1110
yarn

0 commit comments

Comments
 (0)