Skip to content

tools: clean up icu/README.md formatting #8660

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 20, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 8 additions & 11 deletions tools/icu/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
Notes about the icu directory.
===
# Notes about the icu directory.

How to upgrade ICU
---
## How to upgrade ICU

- Make sure your node workspace is clean (clean `git status`) should be sufficient.
- Configure Node with the specific [ICU version](http://icu-project.org/download) you want to upgrade to, for example:

```
```shell
./configure \
--with-intl=small-icu \
--with-icu-source=http://download.icu-project.org/files/icu4c/56.1/icu4c-56_1-src.zip
Expand All @@ -21,7 +19,7 @@ version specific stuff)

- Verify the node build works

```
```shell
make test-ci
```

Expand All @@ -36,15 +34,15 @@ Also running

- Now, copy `deps/icu` over to `deps/icu-small`

```
```shell
python tools/icu/shrink-icu-src.py
```

- Now, do a clean rebuild of node to test:

(TODO: fix this when these options become default)

```
```shell
./configure --with-intl=small-icu --with-icu-source=deps/icu-small
make
```
Expand All @@ -64,7 +62,7 @@ This is a big commit, so make this a separate commit from other changes.
the `configure_intl()` function. It should match the ICU URL used in the
first step. When this is done, the following should build with full ICU.

```
```shell
# clean up
rm -rf out deps/icu deps/icu4c*
./configure --with-intl=full-icu --download=all
Expand All @@ -76,8 +74,7 @@ make test-ci

-----

Notes about these tools
---
## Notes about these tools

The files in this directory were written for the node.js effort. It's
the intent of their author (Steven R. Loomis / srl295) to merge them
Expand Down