Skip to content
This repository was archived by the owner on Oct 7, 2020. It is now read-only.

Commit 522887f

Browse files
committed
readme: initial temporary readme update
Update the repository README file to accurately reflect the intent and nature of this repository. The original io.js README is preserved as iojs_README.md. This is temporary just while the convergence process gets underway. Once the repository moves over to the official organization, this can be reverted back to an actual project README that accurately reflects the combined projects. Reviewed-By: @jasnell James M Snell <[email protected]> Reviewed-By: @Fishrock123 Jeremiah Senkpiel PR-URL: #4
1 parent a5dcff8 commit 522887f

File tree

2 files changed

+316
-298
lines changed

2 files changed

+316
-298
lines changed

README.md

Lines changed: 12 additions & 298 deletions
Original file line numberDiff line numberDiff line change
@@ -1,304 +1,18 @@
1-
io.js
1+
Node.js Foundation - Node.js
22
=====
33

4-
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/iojs/io.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4+
This repository is the working repository for the proposed convergence of the
5+
http://github.com/iojs/io.js and http://github.com/joyent/node projects under
6+
the Node.js Foundation.
57

6-
This repository began as a GitHub fork of
7-
[joyent/node](https://github.com/joyent/node).
8+
Contributions, releases, and contributorship are under the proposed
9+
Governance and Developer Policy for the soon-to-be-launched Node.js
10+
Foundation:
811

9-
io.js contributions, releases, and contributorship are under an
10-
[open governance model](./GOVERNANCE.md).
11-
We intend to land, with increasing regularity, releases which are
12-
compatible with the npm ecosystem that has been built to date for
13-
Node.js.
12+
* https://github.com/joyent/nodejs-advisory-board/tree/master/governance-proposal
13+
* http://github.com/jasnell/dev-policy
1414

15-
## Is it io.js or IO.js or iojs or IOjs or iOjS?
15+
This project is operating with the oversight of the joint Node.js and io.js
16+
core technical teams.
1617

17-
The official name is **io.js**, which should never be capitalized,
18-
especially not at the start of a sentence, unless it is being
19-
displayed in a location that is customarily all-caps (such as
20-
the title of man pages).
21-
22-
## Download
23-
24-
Binaries, installers, and source tarballs are available at
25-
<https://iojs.org>.
26-
27-
**Releases** are available at <https://iojs.org/dist/>, listed under
28-
their version string. The <https://iojs.org/dist/latest/> symlink
29-
will point to the latest release directory.
30-
31-
**Nightly** builds are available at
32-
<https://iojs.org/download/nightly/>, listed under their version
33-
string which includes their date (in UTC time) and the commit SHA at
34-
the HEAD of the release.
35-
36-
**API documentation** is available in each release and nightly
37-
directory under _docs_. <https://iojs.org/api/> points to the the
38-
latest version.
39-
40-
### Verifying Binaries
41-
42-
Release and nightly download directories all contain a *SHASUM256.txt*
43-
file that lists the SHA checksums for each file available for
44-
download. To check that a downloaded file matches the checksum, run
45-
it through `sha256sum` with a command such as:
46-
47-
```
48-
$ grep iojs-vx.y.z.tar.gz SHASUMS256.txt | sha256sum -c -
49-
```
50-
51-
_(Where "iojs-vx.y.z.tar.gz" is the name of the file you have
52-
downloaded)_
53-
54-
Additionally, releases (not nightlies) have GPG signed copies of
55-
SHASUM256.txt files available as SHASUM256.txt.asc. You can use `gpg`
56-
to verify that the file has not been tampered with.
57-
58-
To verify a SHASUM256.txt.asc, you will first need to import all of
59-
the GPG keys of individuals authorized to create releases. They are
60-
listed at the bottom of this README. Use a command such as this to
61-
import the keys:
62-
63-
```
64-
$ gpg --keyserver pool.sks-keyservers.net \
65-
--recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D
66-
```
67-
68-
_(Include each of the key fingerprints at the end of this command.)_
69-
70-
You can then use `gpg --verify SHASUMS256.txt.asc` to verify that the
71-
file has been signed by an authorized member of the io.js team.
72-
73-
Once verified, use the SHASUMS256.txt.asc file to get the checksum for
74-
the binary verification command above.
75-
76-
## Build
77-
78-
### Unix / Macintosh
79-
80-
Prerequisites:
81-
82-
* `gcc` and `g++` 4.8 or newer, or
83-
* `clang` and `clang++` 3.4 or newer
84-
* Python 2.6 or 2.7
85-
* GNU Make 3.81 or newer
86-
* libexecinfo (FreeBSD and OpenBSD only)
87-
88-
```text
89-
$ ./configure
90-
$ make
91-
$ [sudo] make install
92-
```
93-
94-
If your Python binary is in a non-standard location or has a
95-
non-standard name, run the following instead:
96-
97-
```text
98-
$ export PYTHON=/path/to/python
99-
$ $PYTHON ./configure
100-
$ make
101-
$ [sudo] make install
102-
```
103-
104-
To run the tests:
105-
106-
```text
107-
$ make test
108-
```
109-
110-
To build the documentation:
111-
112-
```text
113-
$ make doc
114-
```
115-
116-
To read the documentation:
117-
118-
```text
119-
$ man doc/iojs.1
120-
```
121-
122-
### Windows
123-
124-
Prerequisites:
125-
126-
* [Python 2.6 or 2.7](https://www.python.org/downloads/)
127-
* Visual Studio 2013 for Windows Desktop, or
128-
* Visual Studio Express 2013 for Windows Desktop
129-
* Basic Unix tools required for some tests,
130-
[Git for Windows](http://git-scm.com/download/win) includes Git Bash
131-
and tools which can be included in the global `PATH`.
132-
133-
```text
134-
> vcbuild nosign
135-
```
136-
137-
To run the tests:
138-
139-
```text
140-
> vcbuild test
141-
```
142-
143-
### Android / Android based devices, aka. Firefox OS
144-
145-
Be sure you have downloaded and extracted [Android NDK]
146-
(https://developer.android.com/tools/sdk/ndk/index.html)
147-
before in a folder. Then run:
148-
149-
```
150-
$ ./android-configure /path/to/your/android-ndk
151-
$ make
152-
```
153-
154-
### `Intl` (ECMA-402) support:
155-
156-
[Intl](https://github.com/joyent/node/wiki/Intl) support is not
157-
enabled by default.
158-
159-
#### "small" (English only) support
160-
161-
This option will build with "small" (English only) support, but
162-
the full `Intl` (ECMA-402) APIs. With `--download=all` it will
163-
download the ICU library as needed.
164-
165-
Unix / Macintosh:
166-
167-
```text
168-
$ ./configure --with-intl=small-icu --download=all
169-
```
170-
171-
Windows:
172-
173-
```text
174-
> vcbuild small-icu download-all
175-
```
176-
177-
The `small-icu` mode builds with English-only data. You can add full
178-
data at runtime.
179-
180-
*Note:* more docs are on
181-
[the joyent/node wiki](https://github.com/joyent/node/wiki/Intl).
182-
183-
#### Build with full ICU support (all locales supported by ICU):
184-
185-
With the `--download=all`, this may download ICU if you don't have an
186-
ICU in `deps/icu`.
187-
188-
Unix / Macintosh:
189-
190-
```text
191-
$ ./configure --with-intl=full-icu --download=all
192-
```
193-
194-
Windows:
195-
196-
```text
197-
> vcbuild full-icu download-all
198-
```
199-
200-
#### Build with no Intl support `:-(`
201-
202-
The `Intl` object will not be available. This is the default at
203-
present, so this option is not normally needed.
204-
205-
Unix / Macintosh:
206-
207-
```text
208-
$ ./configure --with-intl=none
209-
```
210-
211-
Windows:
212-
213-
```text
214-
> vcbuild intl-none
215-
```
216-
217-
#### Use existing installed ICU (Unix / Macintosh only):
218-
219-
```text
220-
$ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu
221-
```
222-
223-
#### Build with a specific ICU:
224-
225-
You can find other ICU releases at
226-
[the ICU homepage](http://icu-project.org/download).
227-
Download the file named something like `icu4c-**##.#**-src.tgz` (or
228-
`.zip`).
229-
230-
Unix / Macintosh
231-
232-
```text
233-
# from an already-unpacked ICU:
234-
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu
235-
236-
# from a local ICU tarball
237-
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz
238-
239-
# from a tarball URL
240-
$ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz
241-
```
242-
243-
Windows
244-
245-
First unpack latest ICU to `deps/icu`
246-
[icu4c-**##.#**-src.tgz](http://icu-project.org/download) (or `.zip`)
247-
as `deps/icu` (You'll have: `deps/icu/source/...`)
248-
249-
```text
250-
> vcbuild full-icu
251-
```
252-
253-
## Resources for Newcomers
254-
255-
* [CONTRIBUTING.md](./CONTRIBUTING.md)
256-
* [GOVERNANCE.md](./GOVERNANCE.md)
257-
* IRC:
258-
[#io.js on Freenode.net](http://webchat.freenode.net?channels=io.js&uio=d4)
259-
* [iojs/io.js on Gitter](https://gitter.im/iojs/io.js)
260-
261-
262-
263-
## Current Project Team Members
264-
265-
The io.js project team comprises a group of core collaborators and a sub-group
266-
that forms the _Technical Committee_ (TC) which governs the project. For more
267-
information about the governance of the io.js project, see
268-
[GOVERNANCE.md](./GOVERNANCE.md).
269-
270-
* **Isaac Z. Schlueter** ([@isaacs](https://github.com/isaacs)) &lt;[email protected]&gt; (Technical Committee)
271-
* **Ben Noordhuis** ([@bnoordhuis](https://github.com/bnoordhuis)) &lt;[email protected]&gt; (Technical Committee)
272-
* **Bert Belder** ([@piscisaureus](https://github.com/piscisaureus)) &lt;[email protected]&gt; (Technical Committee)
273-
* **Fedor Indutny** ([@indutny](https://github.com/indutny)) &lt;[email protected]&gt; (Technical Committee)
274-
* **Trevor Norris** ([@trevnorris](https://github.com/trevnorris)) &lt;[email protected]&gt; (Technical Committee)
275-
* **Chris Dickinson** ([@chrisdickinson](https://github.com/chrisdickinson)) &lt;[email protected]&gt; (Technical Committee)
276-
- Release GPG key: 9554F04D7259F04124DE6B476D5A82AC7E37093B
277-
* **Colin Ihrig** ([@cjihrig](https://github.com/cjihrig)) &lt;[email protected]&gt;
278-
* **Mikeal Rogers** ([@mikeal](https://github.com/mikeal)) &lt;[email protected]&gt;
279-
* **Rod Vagg** ([@rvagg](https://github.com/rvagg)) &lt;[email protected]&gt;
280-
- Release GPG key: DD8F2338BAE7501E3DD5AC78C273792F7D83545D
281-
* **Thorsten Lorenz** ([@thlorenz](https://github.com/thlorenz)) &lt;[email protected]&gt;
282-
* **Stephen Belanger** ([@qard](https://github.com/qard)) &lt;[email protected]&gt;
283-
* **Jeremiah Senkpiel** ([@fishrock123](https://github.com/fishrock123)) &lt;[email protected]&gt; (Technical Committee)
284-
- Release GPG key: FD3A5288F042B6850C66B31F09FE44734EB7990E
285-
* **Evan Lucas** ([@evanlucas](https://github.com/evanlucas)) &lt;[email protected]&gt;
286-
* **Brendan Ashworth** ([@brendanashworth](https://github.com/brendanashworth)) &lt;[email protected]&gt;
287-
* **Vladimir Kurchatkin** ([@vkurchatkin](https://github.com/vkurchatkin)) &lt;[email protected]&gt;
288-
* **Nikolai Vavilov** ([@seishun](https://github.com/seishun)) &lt;[email protected]&gt;
289-
* **Nicu Micleușanu** ([@micnic](https://github.com/micnic)) &lt;[email protected]&gt;
290-
* **Aleksey Smolenchuk** ([@lxe](https://github.com/lxe)) &lt;[email protected]&gt;
291-
* **Shigeki Ohtsu** ([@shigeki](https://github.com/shigeki)) &lt;[email protected]&gt;
292-
* **Sam Roberts** ([@sam-github](https://github.com/sam-github)) &lt;[email protected]&gt;
293-
* **Wyatt Preul** ([@geek](https://github.com/geek)) &lt;[email protected]&gt;
294-
* **Brian White** ([@mscdex](https://github.com/mscdex)) &lt;[email protected]&gt;
295-
* **Christian Vaagland Tellnes** ([@tellnes](https://github.com/tellnes)) &lt;[email protected]&gt;
296-
* **Robert Kowalski** ([@robertkowalski](https://github.com/robertkowalski)) &lt;[email protected]&gt;
297-
* **Julian Duque** ([@julianduque](https://github.com/julianduque)) &lt;[email protected]&gt;
298-
* **Johan Bergström** ([@jbergstroem](https://github.com/jbergstroem)) &lt;[email protected]&gt;
299-
* **Roman Reiss** ([@silverwind](https://github.com/silverwind)) &lt;[email protected]&gt;
300-
* **Petka Antonov** ([@petkaantonov](https://github.com/petkaantonov)) &lt;[email protected]&gt;
301-
* **Yosuke Furukawa** ([@yosuke-furukawa](https://github.com/yosuke-furukawa)) &lt;[email protected]&gt;
302-
303-
Collaborators follow the [COLLABORATOR_GUIDE.md](./COLLABORATOR_GUIDE.md) in
304-
maintaining the io.js project.
18+
Note: The original io.js README.md is temporarily renamed to iojs_README.md.

0 commit comments

Comments
 (0)